com.perforce.p4java.option.server
Class GetRevisionHistoryOptions

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

public class GetRevisionHistoryOptions
extends Options

Options class for IOptionsServer.getRevisionHistory method.

Note that behavior is undefined if both longOutput and truncatedLongOutput are true. If both are false, a short form of the description (prepared by the server) is returned.

See Also:

IOptionsServer.getRevisionHistory(java.util.List, com.perforce.p4java.option.server.GetRevisionHistoryOptions)

Field Summary

protected int	changelistId If positive, displays only files submitted at the given changelist number.
protected boolean	contentHistory If true, display file content history instead of file name history.
protected boolean	includeInherited If true, causes inherited file history to be displayed as well.
protected boolean	longOutput If true, produces long output with the full text of the changelist descriptions.
protected int	maxRevs If positive, displays at most 'maxRevs' revisions per file of the file[rev] argument specified.
protected boolean	omitNonContributaryIntegrations If true, omit non-contributory integrations; corresponds to -s.
static String	OPTIONS_SPECS Options: -c[changelist], -m[max], -h, -i, -l, -L, -s
protected boolean	truncatedLongOutput If true, produces long output with the full text of the changelist descriptions truncated to 250 characters.

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

immutable, optionList, OPTPFX

Constructor Summary

GetRevisionHistoryOptions()
Default constructor.

GetRevisionHistoryOptions(int changelistId, int maxRevs, boolean contentHistory, boolean includeInherited, boolean longOutput, boolean truncatedLongOutput)
Explicit-value constructor.

GetRevisionHistoryOptions(int changelistId, int maxRevs, boolean contentHistory, boolean includeInherited, boolean longOutput, boolean truncatedLongOutput, boolean omitNonContributaryIntegrations)
Explicit-value constructor.

GetRevisionHistoryOptions(String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.

Method Summary

int	getChangelistId()
int	getMaxRevs()
boolean	isContentHistory()
boolean	isIncludeInherited()
boolean	isLongOutput()
boolean	isOmitNonContributaryIntegrations()
boolean	isTruncatedLongOutput()
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.
GetRevisionHistoryOptions	setChangelistId(int changelistId)
GetRevisionHistoryOptions	setContentHistory(boolean contentHistory)
GetRevisionHistoryOptions	setIncludeInherited(boolean includeInherited)
GetRevisionHistoryOptions	setLongOutput(boolean longOutput)
GetRevisionHistoryOptions	setMaxRevs(int maxRevs)
GetRevisionHistoryOptions	setOmitNonContributaryIntegrations(boolean omitNonContributaryIntegrations)
GetRevisionHistoryOptions	setTruncatedLongOutput(boolean truncatedLongOutput)

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: -c[changelist], -m[max], -h, -i, -l, -L, -s

See Also:

Constant Field Values

changelistId

protected int changelistId

If positive, displays only files submitted at the given changelist number. Corresponds to -c#.

maxRevs

protected int maxRevs

If positive, displays at most 'maxRevs' revisions per file of the file[rev] argument specified. Corresponds to -m.

contentHistory

protected boolean contentHistory

If true, display file content history instead of file name history. Corresponds to -h.

includeInherited

protected boolean includeInherited

If true, causes inherited file history to be displayed as well. Corresponds to -i.

longOutput

protected boolean longOutput

If true, produces long output with the full text of the changelist descriptions. Corresponds to -l.

truncatedLongOutput

protected boolean truncatedLongOutput

If true, produces long output with the full text of the changelist descriptions truncated to 250 characters. Corresponds to -L.

omitNonContributaryIntegrations

protected boolean omitNonContributaryIntegrations

If true, omit non-contributory integrations; corresponds to -s.

Since:

2011.1

Constructor Detail

GetRevisionHistoryOptions

public GetRevisionHistoryOptions()

Default constructor.

GetRevisionHistoryOptions

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

GetRevisionHistoryOptions

public GetRevisionHistoryOptions(int changelistId,
                                 int maxRevs,
                                 boolean contentHistory,
                                 boolean includeInherited,
                                 boolean longOutput,
                                 boolean truncatedLongOutput)

Explicit-value constructor.

GetRevisionHistoryOptions

public GetRevisionHistoryOptions(int changelistId,
                                 int maxRevs,
                                 boolean contentHistory,
                                 boolean includeInherited,
                                 boolean longOutput,
                                 boolean truncatedLongOutput,
                                 boolean omitNonContributaryIntegrations)

Explicit-value constructor.

Since:

2011.1

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)

getChangelistId

public int getChangelistId()

setChangelistId

public GetRevisionHistoryOptions setChangelistId(int changelistId)

getMaxRevs

public int getMaxRevs()

setMaxRevs

public GetRevisionHistoryOptions setMaxRevs(int maxRevs)

isContentHistory

public boolean isContentHistory()

setContentHistory

public GetRevisionHistoryOptions setContentHistory(boolean contentHistory)

isIncludeInherited

public boolean isIncludeInherited()

setIncludeInherited

public GetRevisionHistoryOptions setIncludeInherited(boolean includeInherited)

isLongOutput

public boolean isLongOutput()

setLongOutput

public GetRevisionHistoryOptions setLongOutput(boolean longOutput)

isTruncatedLongOutput

public boolean isTruncatedLongOutput()

setTruncatedLongOutput

public GetRevisionHistoryOptions setTruncatedLongOutput(boolean truncatedLongOutput)

isOmitNonContributaryIntegrations

public boolean isOmitNonContributaryIntegrations()

Since:

2011.1

setOmitNonContributaryIntegrations

public GetRevisionHistoryOptions setOmitNonContributaryIntegrations(boolean omitNonContributaryIntegrations)

Since:

2011.1