Package com.perforce.p4java.option.server

Class ReloadOptions

  • public class ReloadOptions
extends Options
    Options class for Perforce reload methods.

    Note that the full semantics of these options are found in the main 'p4 help reload' documentation.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String client
      If not null, unload the specified client.
      protected boolean force
      If true, forces the unloading of the specified client or label.
      protected java.lang.String label
      If not null, unload the specified label.
      static java.lang.String OPTIONS_SPECS
      Options: [-f] [-c client | -l label | -s stream]
      protected java.lang.String stream
      If not null, unload the specified task stream.

    • Constructor Summary

      Constructors 
      Constructor Description
      ReloadOptions()
      Default constructor.
      ReloadOptions​(boolean force, java.lang.String client, java.lang.String label)
      Explicit value constructor.
      ReloadOptions​(java.lang.String... options)
      Strings-based constructor; see 'p4 help [command]' for possible options.

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: [-f] [-c client | -l label | -s stream]
        See Also:
        Constant Field Values

      • force

        protected boolean force
        If true, forces the unloading of the specified client or label. Corresponds to the -f flag.

        By default, users can only unload their own clients or labels. The -f flag requires 'admin' access, which is granted by 'p4 protect'.

      • client

        protected java.lang.String client
        If not null, unload the specified client. Corresponds to the -c client flag.

      • label

        protected java.lang.String label
        If not null, unload the specified label. Corresponds to the -l label flag.

      • stream

        protected java.lang.String stream
        If not null, unload the specified task stream. Corresponds to the -s label flag.

    • Constructor Detail

      • ReloadOptions

        public ReloadOptions()
        Default constructor.

      • ReloadOptions

        public ReloadOptions​(java.lang.String... options)
        Strings-based constructor; see 'p4 help [command]' for possible options.

        WARNING: you should not pass more than one option or argument in each string parameter. Each option or argument should be passed-in as its own separate string parameter, without any spaces between the option and the option value (if any).

        NOTE: setting options this way always bypasses the internal options values, and getter methods against the individual values corresponding to the strings passed in to this constructor will not normally reflect the string's setting. Do not use this constructor unless you know what you're doing and / or you do not also use the field getters and setters.

        Parameters:
        options - options
        See Also:
        Options(java.lang.String...)

      • ReloadOptions

        public ReloadOptions​(boolean force,
                     java.lang.String client,
                     java.lang.String label)
        Explicit value constructor.
        Parameters:
        force - force
        client - client
        label - label

    • Method Detail

      • processOptions

        public java.util.List<java.lang.String> processOptions​(IServer server)
                                                throws OptionsException
        Description copied from class: Options
        Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

        The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.

        Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.

        Specified by:
        processOptions in class Options
        Parameters:
        server - possibly-null IServer representing the Perforce server the options are to be used against. If this parameter is null, it is acceptable to throw an OptionsException, but it is also possible to ignore it and do the best you can with what you've got...
        Returns:
        non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.
        Throws:
        OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.
        See Also:
        Options.processOptions(com.perforce.p4java.server.IServer)

      • isForce

        public boolean isForce()

      • getClient

        public java.lang.String getClient()

      • setClient

        public ReloadOptions setClient​(java.lang.String client)

      • getLabel

        public java.lang.String getLabel()

      • setLabel

        public ReloadOptions setLabel​(java.lang.String label)

      • getStream

        public java.lang.String getStream()

      • setStream

        public ReloadOptions setStream​(java.lang.String stream)