public class UnloadOptions extends Options
Note that the full semantics of these options are found in the main 'p4 help unload' documentation.
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
all
If not null, specifies set of clients and/or labels are unloaded.
|
protected java.lang.String |
client
If not null, unload the specified client.
|
protected boolean |
compress
If true, specifies that the client or label should be stored in
compressed format.
|
protected java.lang.String |
date
If not null, unload all clients and/or labels older than that date.
|
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.
|
protected boolean |
locked
If true, specifies that the client, label, or task stream should be
unloaded even if it is locked.
|
static java.lang.String |
OPTIONS_SPECS
Options: p4 unload [-f -L -z] [-c client | -l label | -s stream]
|
protected java.lang.String |
stream
If not null, unload the specified task stream.
|
protected java.lang.String |
user
If not null, unload all clients and/or labels owned by that user.
|
immutable, optionList
Constructor and Description |
---|
UnloadOptions()
Default constructor.
|
UnloadOptions(boolean force,
boolean compress,
java.lang.String client,
java.lang.String label)
Explicit value constructor.
|
UnloadOptions(boolean force,
boolean compress,
java.lang.String all,
java.lang.String date,
java.lang.String user)
Explicit value constructor.
|
UnloadOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAll() |
java.lang.String |
getClient() |
java.lang.String |
getDate() |
java.lang.String |
getLabel() |
java.lang.String |
getStream() |
java.lang.String |
getUser() |
boolean |
isCompress() |
boolean |
isForce() |
boolean |
isLocked() |
java.util.List<java.lang.String> |
processOptions(IServer server)
Turn this (specific) options object into a list of strings to be sent to
the Perforce server as options for a specific command.
|
UnloadOptions |
setAll(java.lang.String all) |
UnloadOptions |
setClient(java.lang.String client) |
UnloadOptions |
setCompress(boolean compress) |
UnloadOptions |
setDate(java.lang.String date) |
UnloadOptions |
setForce(boolean force) |
UnloadOptions |
setLabel(java.lang.String label) |
UnloadOptions |
setLocked(boolean locked) |
UnloadOptions |
setStream(java.lang.String stream) |
UnloadOptions |
setUser(java.lang.String user) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
Options: p4 unload [-f -L -z] [-a|-al|-ac] [-d date | -u user]
protected boolean force
By default, users can only unload their own clients or labels. The -f flag requires 'admin' access, which is granted by 'p4 protect'.
protected boolean locked
protected boolean compress
protected java.lang.String client
protected java.lang.String label
protected java.lang.String stream
protected java.lang.String all
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.
protected java.lang.String date
The following are valid Perforce date string formats:
yyyy/mm/dd yyyy/mm/dd:hh:mm:ss yyyy/mm/dd hh:mm:ss
protected java.lang.String user
public UnloadOptions()
public UnloadOptions(java.lang.String... 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.
options
- optionsOptions(java.lang.String...)
public UnloadOptions(boolean force, boolean compress, java.lang.String client, java.lang.String label)
force
- forcecompress
- compressclient
- clientlabel
- labelpublic UnloadOptions(boolean force, boolean compress, java.lang.String all, java.lang.String date, java.lang.String user)
force
- forcecompress
- compressall
- alldate
- dateuser
- userpublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
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.
processOptions
in class Options
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...OptionsException
- if an error occurs in options processing that is not some
species of ConnectionException, RequestException,
AccessException, etc.Options.processOptions(com.perforce.p4java.server.IServer)
public boolean isForce()
public UnloadOptions setForce(boolean force)
public boolean isLocked()
public UnloadOptions setLocked(boolean locked)
public boolean isCompress()
public UnloadOptions setCompress(boolean compress)
public java.lang.String getClient()
public UnloadOptions setClient(java.lang.String client)
public java.lang.String getLabel()
public UnloadOptions setLabel(java.lang.String label)
public java.lang.String getStream()
public UnloadOptions setStream(java.lang.String stream)
public java.lang.String getAll()
public UnloadOptions setAll(java.lang.String all)
public java.lang.String getDate()
public UnloadOptions setDate(java.lang.String date)
public java.lang.String getUser()
public UnloadOptions setUser(java.lang.String user)