public class PropertyOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
group
If not null, use this as the user group to which this property applies.
|
protected java.lang.String |
name
If not null, use this as the name of this property.
|
static java.lang.String |
OPTIONS_SPECS
Options: -n name -v value [-s sequence] [-u user | -g group]
|
protected java.lang.String |
sequence
If greater than zero, use this as the sequence number of this property.
|
protected java.lang.String |
user
If not null, use this as the user to whom this property applies.
|
protected java.lang.String |
value
If not null, use this as the value of this property.
|
immutable, optionList
Constructor and Description |
---|
PropertyOptions()
Default constructor.
|
PropertyOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
PropertyOptions(java.lang.String name,
java.lang.String value,
java.lang.String sequence,
java.lang.String user,
java.lang.String group)
Explicit value constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getGroup() |
java.lang.String |
getName() |
java.lang.String |
getSequence() |
java.lang.String |
getUser() |
java.lang.String |
getValue() |
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.
|
PropertyOptions |
setGroup(java.lang.String group) |
PropertyOptions |
setName(java.lang.String name) |
PropertyOptions |
setSequence(java.lang.String sequence) |
PropertyOptions |
setUser(java.lang.String user) |
PropertyOptions |
setValue(java.lang.String value) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected java.lang.String name
protected java.lang.String value
protected java.lang.String sequence
protected java.lang.String user
protected java.lang.String group
public PropertyOptions()
public PropertyOptions(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 PropertyOptions(java.lang.String name, java.lang.String value, java.lang.String sequence, java.lang.String user, java.lang.String group)
name
- namevalue
- valuesequence
- sequenceuser
- usergroup
- grouppublic 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 java.lang.String getName()
public PropertyOptions setName(java.lang.String name)
public java.lang.String getValue()
public PropertyOptions setValue(java.lang.String value)
public java.lang.String getSequence()
public PropertyOptions setSequence(java.lang.String sequence)
public java.lang.String getUser()
public PropertyOptions setUser(java.lang.String user)
public java.lang.String getGroup()
public PropertyOptions setGroup(java.lang.String group)