Package com.perforce.p4java.option.server

Class GraphShowRefOptions

java.lang.Object

com.perforce.p4java.option.Options

com.perforce.p4java.option.server.GraphShowRefOptions

public class GraphShowRefOptions
extends Options

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	OPTIONS_SPECS
static java.lang.String	SHOWREF_COMMAND_PART

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

immutable, optionList

Constructor Summary

Constructors

Constructor	Description
GraphShowRefOptions()
GraphShowRefOptions(java.lang.String repo, int maxValue, boolean a, java.lang.String user, java.lang.String type)

Method Summary

Modifier and Type	Method	Description
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.
GraphShowRefOptions	setA(boolean a)	Sets the optional option value for option -a
GraphShowRefOptions	setMaxValue(int maxValue)	Sets the optional option value for option -m {max}
GraphShowRefOptions	setRepo(java.lang.String repo)	Sets the mandatory option value for option -n {repo}
GraphShowRefOptions	setType(java.lang.String type)	Sets the optional option value for option -t {type}
GraphShowRefOptions	setUser(java.lang.String user)	Sets the optional option value for option -u {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

SHOWREF_COMMAND_PART

public static final java.lang.String SHOWREF_COMMAND_PART

See Also:

Constant Field Values

OPTIONS_SPECS

public static final java.lang.String OPTIONS_SPECS

See Also:

Constant Field Values

Constructor Detail

GraphShowRefOptions

public GraphShowRefOptions()

GraphShowRefOptions

public GraphShowRefOptions(java.lang.String repo,
                           int maxValue,
                           boolean a,
                           java.lang.String user,
                           java.lang.String type)

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:

list of options strings associated with this Option

Throws:

OptionsException - on error

setRepo

public GraphShowRefOptions setRepo(java.lang.String repo)

Sets the mandatory option value for option -n {repo}

Parameters:

repo - - The repo against which the rev-list command is issued

Returns:

GraphShowRefOptions with repo filter set

setMaxValue

public GraphShowRefOptions setMaxValue(int maxValue)

Sets the optional option value for option -m {max}

Parameters:

maxValue - - The maximum number of items to be returned by the graph rev-list command

Returns:

GraphShowRefOptions with max value filter set

setA

public GraphShowRefOptions setA(boolean a)

Sets the optional option value for option -a

Parameters:

a - - true or false

Returns:

GraphShowRefOptions with 'A' filter set

setUser

public GraphShowRefOptions setUser(java.lang.String user)

Sets the optional option value for option -u {user}

Parameters:

user - - user to filter with

Returns:

GraphShowRefOptions with use filter set

setType

public GraphShowRefOptions setType(java.lang.String type)

Sets the optional option value for option -t {type}

Parameters:

type - - options type

Returns:

GraphShowRefOptions with type filter set