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 Summary

Fields

Modifier and Type	Field	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.

Fields inherited from class com.perforce.p4java.option.Options

immutable, optionList

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	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)

Methods inherited from class com.perforce.p4java.option.Options

getOptions, isImmutable, processFields, setImmutable, setOptions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPTIONS_SPECS

public static final java.lang.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:

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

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

all

protected java.lang.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 java.lang.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 java.lang.String user

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

Constructor Detail

UnloadOptions

public UnloadOptions()

Default constructor.

UnloadOptions

public UnloadOptions(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...)

UnloadOptions

public UnloadOptions(boolean force,
                     boolean compress,
                     java.lang.String client,
                     java.lang.String label)

Explicit value constructor.

Parameters:

force - force

compress - compress

client - client

label - label

UnloadOptions

public UnloadOptions(boolean force,
                     boolean compress,
                     java.lang.String all,
                     java.lang.String date,
                     java.lang.String user)

Explicit value constructor.

Parameters:

force - force

compress - compress

all - all

date - date

user - user

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()

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 java.lang.String getClient()

setClient

public UnloadOptions setClient(java.lang.String client)

getLabel

public java.lang.String getLabel()

setLabel

public UnloadOptions setLabel(java.lang.String label)

getStream

public java.lang.String getStream()

setStream

public UnloadOptions setStream(java.lang.String stream)

getAll

public java.lang.String getAll()

setAll

public UnloadOptions setAll(java.lang.String all)

getDate

public java.lang.String getDate()

setDate

public UnloadOptions setDate(java.lang.String date)

getUser

public java.lang.String getUser()

setUser

public UnloadOptions setUser(java.lang.String user)