com.perforce.p4java.impl.mapbased.server.cmd

Class FileLogDelegator

java.lang.Object

com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

com.perforce.p4java.impl.mapbased.server.cmd.FileLogDelegator

All Implemented Interfaces:

IFileLogDelegator

public class FileLogDelegator
extends BaseDelegator
implements IFileLogDelegator

Since:

23/09/2016

Author:

Sean Shou

Field Summary

Fields inherited from class com.perforce.p4java.impl.mapbased.server.cmd.BaseDelegator

MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION

Constructor Summary

Constructors

Constructor and Description
FileLogDelegator(IOptionsServer server) Instantiate a new FileDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Method Summary

Modifier and Type	Method and Description
Map<IFileSpec,List<IFileRevisionData>>	getRevisionHistory(List<IFileSpec> fileSpecs, GetRevisionHistoryOptions opts) Get the revision history data for one or more Perforce files.
Map<IFileSpec,List<IFileRevisionData>>	getRevisionHistory(List<IFileSpec> fileSpecs, int maxRevs, boolean contentHistory, boolean includeInherited, boolean longOutput, boolean truncatedLongOutput) Get the revision history data for one or more Perforce files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileLogDelegator

public FileLogDelegator(IOptionsServer server)

Instantiate a new FileDelegator, providing the server object that will be used to execute Perforce Helix attribute commands.

Parameters:

server - a concrete implementation of a Perforce Helix Server

Method Detail

getRevisionHistory

public Map<IFileSpec,List<IFileRevisionData>> getRevisionHistory(List<IFileSpec> fileSpecs,
                                                                 int maxRevs,
                                                                 boolean contentHistory,
                                                                 boolean includeInherited,
                                                                 boolean longOutput,
                                                                 boolean truncatedLongOutput)
                                                          throws ConnectionException,
                                                                 AccessException

Description copied from interface: IFileLogDelegator

Get the revision history data for one or more Perforce files.

Specified by:

getRevisionHistory in interface IFileLogDelegator

Parameters:

fileSpecs - fileSpecs to be processed; if null or empty, an empty Map is returned.

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

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

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

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

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

Throws:

ConnectionException

AccessException

getRevisionHistory

public Map<IFileSpec,List<IFileRevisionData>> getRevisionHistory(List<IFileSpec> fileSpecs,
                                                                 GetRevisionHistoryOptions opts)
                                                          throws P4JavaException

Description copied from interface: IFileLogDelegator

Get the revision history data for one or more Perforce files.

Specified by:

getRevisionHistory in interface IFileLogDelegator

Parameters:

fileSpecs - fileSpecs to be processed; if null or empty, an empty Map is returned.

opts - GetRevisionHistoryOptions object describing optional parameters; if null, no options are set.

Returns:

a non-null map of lists of revision data for qualifying files; the map is keyed by the IFileSpec of the associated file, meaning that errors are signaled using the normal IFileSpec getOpStatus() method.

Throws:

P4JavaException - if any error occurs in the processing of this method.