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 GetKeysOptions

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

public class GetKeysOptions
extends Options

Options class for the IOptionsServer's getKeys method.

Field Summary
protected  int maxResults
          If greater than zero, limit output to the first maxResults number of keys.
protected  String nameFilter
          If non-null, limits output to keys whose name matches the nameFilter pattern.
protected  String[] nameFilters
          If non-null, limits output to keys whose name matches any of the nameFilter patterns.
static String OPTIONS_SPECS
          Options: -u, -e[nameFilter] ..., -m[max]
protected  boolean undocKey
           
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
GetKeysOptions()
          Default constructor.
GetKeysOptions(boolean undocKey, String nameFilter, int maxResults)
          Explicit value constructor.
GetKeysOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 int getMaxResults()
           
 String getNameFilter()
           
 String[] getNameFilters()
           
 boolean isUndocKey()
           
 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.
 GetKeysOptions setMaxResults(int maxResults)
           
 GetKeysOptions setNameFilter(String nameFilter)
           
 GetKeysOptions setNameFilters(String[] nameFilters)
           
 GetKeysOptions setUndocKey(boolean undocKey)
           
 
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: -u, -e[nameFilter] ..., -m[max]

See Also:
Constant Field Values

undocKey

protected boolean undocKey

nameFilter

protected String nameFilter
If non-null, limits output to keys whose name matches the nameFilter pattern. Corresponds to '-e nameFilter' flag

nameFilters

protected String[] nameFilters
If non-null, limits output to keys whose name matches any of the nameFilter patterns. Corresponds to the multiple '-u -e nameFilter -e nameFilter -e nameFilter ...' flags.

maxResults

protected int maxResults
If greater than zero, limit output to the first maxResults number of keys. Corresponds to '-m max' flag.

Constructor Detail

GetKeysOptions

public GetKeysOptions()
Default constructor.

GetKeysOptions

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

GetKeysOptions

public GetKeysOptions(boolean undocKey,
                      String nameFilter,
                      int maxResults)
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)

isUndocKey

public boolean isUndocKey()

setUndocKey

public GetKeysOptions setUndocKey(boolean undocKey)

getNameFilter

public String getNameFilter()

setNameFilter

public GetKeysOptions setNameFilter(String nameFilter)

getNameFilters

public String[] getNameFilters()

setNameFilters

public GetKeysOptions setNameFilters(String[] nameFilters)

getMaxResults

public int getMaxResults()

setMaxResults

public GetKeysOptions setMaxResults(int maxResults)
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.