Package com.perforce.p4java.option.server

Class UnloadOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.UnloadOptions
public class UnloadOptions extends Options
Options class for Perforce unload methods.

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

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: p4 unload [-f -L -z] [-c client | -l label | -s stream]

      Options: p4 unload [-f -L -z] [-a|-al|-ac] [-d date | -u user]

      See Also:

    • 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'.

    • locked

      protected boolean locked
      If true, specifies that the client, label, or task stream should be unloaded even if it is locked. Corresponds to the -L flag.

    • compress

      protected boolean compress
      If true, specifies that the client or label should be stored in compressed format. Corresponds to the -z flag.

    • client

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

    • label

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

    • stream

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

    • all

      protected String all
      If not null, specifies set of clients and/or labels are unloaded. Corresponds to the -a, -al -ac flags.

      If it is empty (empty string ""), it would unload all (-a) clients and labels. If it is "c", it would unload all clients (-ac). If it is "l", it would unload all labels (-al).

      Note that if the -a flag is specified, the specified set of clients and/or labels are unloaded. Specify -d and a date to unload all clients and/or labels older than that date. When -a is specified, you must specify either -d or -u (or both), and you may not specify the -c or -l flags.

    • date

      protected String date
      If not null, unload all clients and/or labels older than that date. Corresponds to the -d date flag.

      The following are valid Perforce date string formats: 

       yyyy/mm/dd
 yyyy/mm/dd:hh:mm:ss
 yyyy/mm/dd hh:mm:ss

    • user

      protected String user
      If not null, unload all clients and/or labels owned by that user. Corresponds to the -u user flag.

  • Constructor Details

    • UnloadOptions

      public UnloadOptions()
      Default constructor.

    • UnloadOptions

      public UnloadOptions(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:

    • UnloadOptions

      public UnloadOptions(boolean force, boolean compress, String client, String label)
      Explicit value constructor.
      Parameters:
      force - force
      compress - compress
      client - client
      label - label

    • UnloadOptions

      public UnloadOptions(boolean force, boolean compress, String all, String date, String user)
      Explicit value constructor.
      Parameters:
      force - force
      compress - compress
      all - all
      date - date
      user - user

  • Method Details

    • processOptions

      public List<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:

    • isForce

      public boolean isForce()

    • setForce

      public UnloadOptions setForce(boolean force)

    • isLocked

      public boolean isLocked()

    • setLocked

      public UnloadOptions setLocked(boolean locked)

    • isCompress

      public boolean isCompress()

    • setCompress

      public UnloadOptions setCompress(boolean compress)

    • getClient

      public String getClient()

    • setClient

      public UnloadOptions setClient(String client)

    • getLabel

      public String getLabel()

    • setLabel

      public UnloadOptions setLabel(String label)

    • getStream

      public String getStream()

    • setStream

      public UnloadOptions setStream(String stream)

    • getAll

      public String getAll()

    • setAll

      public UnloadOptions setAll(String all)

    • getDate

      public String getDate()

    • setDate

      public UnloadOptions setDate(String date)

    • getUser

      public String getUser()

    • setUser

      public UnloadOptions setUser(String user)