com.perforce.p4java.server.delegator

Interface IFstatDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

FstatDelegator, NtsServerImpl, OneShotServerImpl, RpcServer, Server

public interface IFstatDelegator

Interface for 'p4 fstat'.

Method Summary

Modifier and Type	Method and Description
List<IExtendedFileSpec>	getExtendedFiles(List<IFileSpec> fileSpecs, GetExtendedFilesOptions opts) Return a list of everything Perforce knows about a set of Perforce files.
List<IExtendedFileSpec>	getExtendedFiles(List<IFileSpec> fileSpecs, int maxFiles, int sinceChangelist, int affectedByChangelist, FileStatOutputOptions outputOptions, FileStatAncilliaryOptions ancilliaryOptions) Return a list of everything Perforce knows about a possibly very large set of Perforce files.

Method Detail

getExtendedFiles

List<IExtendedFileSpec> getExtendedFiles(List<IFileSpec> fileSpecs,
                                         int maxFiles,
                                         int sinceChangelist,
                                         int affectedByChangelist,
                                         FileStatOutputOptions outputOptions,
                                         FileStatAncilliaryOptions ancilliaryOptions)
                                  throws ConnectionException,
                                         AccessException

Return a list of everything Perforce knows about a possibly very large set of Perforce files.

This method is not intended for general use, and is not documented in detail here; consult the main Perforce fstat command documentation for detailed help. In particular, the various options are too complex to be described in a few sentences here, and the various option arguments reflect this complexity. Note that setting both sinceChangelist and affectedByChangelist to zero or a positive value will cause usage errors from the server (these are currently intended to be mutually-exclusive options).

This method can be a real server and bandwidth resource hog, and should be used as sparingly as possible; alternatively, try to use it with as narrow a set of file specs as possible.

Parameters:

fileSpecs - non-null list of Perforce file specification(s)

maxFiles - if positive, restrict the output to the first maxReturns files. Implementations are free to ignore this parameter if necessary (and return all qualifying results).

sinceChangelist - if larger than or equal to zero, display only files affected since the given changelist number; zero is equivalent to IChangelist.DEFAULT.

affectedByChangelist - if larger than or equal to zero, display only files affected by the given changelist number; zero is equivalent to IChangelist.DEFAULT.

outputOptions - if non-null, specifies the oputput options to be used

ancilliaryOptions - if non-null, specifies the ancilliary output options to be used

Returns:

a non-null (but possibly empty) list of qualifying files and associated stat info

Throws:

ConnectionException - if the Perforce server is unreachable or is not connected.

AccessException - if the Perforce server denies access to the caller

getExtendedFiles

List<IExtendedFileSpec> getExtendedFiles(List<IFileSpec> fileSpecs,
                                         GetExtendedFilesOptions opts)
                                  throws P4JavaException

Return a list of everything Perforce knows about a set of Perforce files.

This method is not intended for general use, and is not documented in detail here; consult the main Perforce fstat command documentation for detailed help. This method can be a real server and bandwidth resource hog, and should be used as sparingly as possible; alternatively, try to use it with as narrow a set of file specs as possible.

Parameters:

fileSpecs - non-null list of Perforce file specification(s).

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

Returns:

non-null (but possibly empty) list of qualifying files and associated stat info.

Throws:

P4JavaException - if an error occurs processing this method and its parameters.