com.perforce.p4java.option.server
Class DescribeOptions

java.lang.Object
  com.perforce.p4java.option.Options
      com.perforce.p4java.option.server.DescribeOptions

public class DescribeOptions
extends Options

Options class for the different options that can be specified when running a describe on a changelist

Field Summary

static String

OPTIONS_SPECS

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

immutable, optionList, OPTPFX

Constructor Summary

DescribeOptions()
Create a changelist describe options

DescribeOptions(DiffType type)
Create a changelist describe options

DescribeOptions(DiffType type, boolean outputShelvedDiffs)
Create a changelist describe options

Method Summary

DiffType	getType()
boolean	isOutputShelvedDiffs()
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.
DescribeOptions	setOutputShelvedDiffs(boolean showShelvedDiffs)
DescribeOptions	setType(DiffType type)

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

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

Constructor Detail

DescribeOptions

public DescribeOptions()

Create a changelist describe options

DescribeOptions

public DescribeOptions(DiffType type)

Create a changelist describe options

Parameters:

type -

DescribeOptions

public DescribeOptions(DiffType type,
                       boolean outputShelvedDiffs)

Create a changelist describe options

Parameters:

type -

outputShelvedDiffs -

Method Detail

getType

public DiffType getType()

Returns:

the type

setType

public DescribeOptions setType(DiffType type)

Parameters:

type - the type to set

isOutputShelvedDiffs

public boolean isOutputShelvedDiffs()

Returns:

the showShelvedDiffs

setOutputShelvedDiffs

public DescribeOptions setOutputShelvedDiffs(boolean showShelvedDiffs)

Parameters:

showShelvedDiffs - the showShelvedDiffs to set

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)