Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.option.server
Class PropertyOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.server.PropertyOptions

public class PropertyOptions
extends Options

Options class for IOptionsServer's setProperty and deleteProperty methods.

Field Summary
protected  String group
          If not null, use this as the user group to which this property applies.
protected  String name
          If not null, use this as the name of this property.
static String OPTIONS_SPECS
          Options: -n name -v value [-s sequence] [-u user | -g group]
protected  int sequence
          If greater than zero, use this as the sequence number of this property.
protected  String user
          If not null, use this as the user to whom this property applies.
protected  String value
          If not null, use this as the value of this property.
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
PropertyOptions()
          Default constructor.
PropertyOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
PropertyOptions(String name, String value, int sequence, String user, String group)
          Explicit value constructor.
 
Method Summary
 String getGroup()
           
 String getName()
           
 int getSequence()
           
 String getUser()
           
 String getValue()
           
 List<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(String group)
           
 PropertyOptions setName(String name)
           
 PropertyOptions setSequence(int sequence)
           
 PropertyOptions setUser(String user)
           
 PropertyOptions setValue(String value)
           
 
Methods inherited from class com.perforce.p4java.option.Options
applyRule, applyRule, applyRule, applyRule, 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 String OPTIONS_SPECS
Options: -n name -v value [-s sequence] [-u user | -g group]

See Also:
Constant Field Values

name

protected String name
If not null, use this as the name of this property. Corresponds to the -n flag.

value

protected String value
If not null, use this as the value of this property. Corresponds to the -v flag.

sequence

protected int sequence
If greater than zero, use this as the sequence number of this property. If the sequence is not specified, it defaults to 1. Corresponds to the -s flag.

user

protected String user
If not null, use this as the user to whom this property applies. Corresponds to the -u flag.

group

protected String group
If not null, use this as the user group to which this property applies. Corresponds to the -g flag.

Constructor Detail

PropertyOptions

public PropertyOptions()
Default constructor.

PropertyOptions

public PropertyOptions(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.

See Also:
Options.Options(java.lang.String...)

PropertyOptions

public PropertyOptions(String name,
                       String value,
                       int sequence,
                       String user,
                       String group)
Explicit value constructor.

Method Detail

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:
Options.processOptions(com.perforce.p4java.server.IServer)

getName

public String getName()

setName

public PropertyOptions setName(String name)

getValue

public String getValue()

setValue

public PropertyOptions setValue(String value)

getSequence

public int getSequence()

setSequence

public PropertyOptions setSequence(int sequence)

getUser

public String getUser()

setUser

public PropertyOptions setUser(String user)

getGroup

public String getGroup()

setGroup

public PropertyOptions setGroup(String group)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.