Package com.perforce.p4java.server.delegator

Interface IDescribeDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

DescribeDelegator, NtsServerImpl, OneShotServerImpl, RpcServer, Server

public interface IDescribeDelegator

Method Summary

Modifier and Type	Method	Description
java.io.InputStream	getChangelistDiffs(int id, GetChangelistDiffsOptions opts)	Get an InputStream onto the file diffs associated with a specific submitted changelist.
java.io.InputStream	getChangelistDiffsStream(int id, DescribeOptions options)	Get an InputStream onto the file diffs associated with a specific submitted changelist.
java.util.List<IExtendedFileSpec>	getChangelistExtendedFiles(int id)	Get an extended list of the Perforce depot files associated with a Perforce changelist.
java.util.List<IExtendedFileSpec>	getChangelistExtendedFiles(int id, int max)	Get an extended list of the Perforce depot files associated with a Perforce changelist.
java.util.List<IFileSpec>	getChangelistFiles(int id)	Get a list of the Perforce depot files associated with a Perforce changelist.
java.util.List<IFileSpec>	getChangelistFiles(int id, int max)	Get a list of the Perforce depot files associated with a Perforce changelist.
java.util.List<IFileSpec>	getShelvedFiles(int changelistId)	Get a list of shelved files associated with a Perforce pending changelist.
java.util.List<IFileSpec>	getShelvedFiles(int changelistId, int max)	Get a list of shelved files associated with a Perforce pending changelist.

Method Detail

getChangelistDiffs

java.io.InputStream getChangelistDiffs(int id,
                                       GetChangelistDiffsOptions opts)
                                throws P4JavaException

Get an InputStream onto the file diffs associated with a specific submitted changelist. This method (like the similar "p4 describe" command) will not return diffs for pending changelists.

This is one of the guaranteed "live" method on this interface, and will return the diff output as it exists when called (rather than when the underlying implementation object was created). This can be an expensive method to evaluate, and can generate reams and reams (and reams) of output, so don't use it willy-nilly.

Note that unlike the corresponding command-line command, which keeps going in the face of errors by moving on to the next file (or whatever), any errors encountered in this method will cause an exception from this method at the first error, so plan accordingly....

Parameters:

id - the ID of the target changelist.

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

Returns:

InputStream onto the diff stream. Note that while this stream will not be null, it may be empty.

Throws:

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

getChangelistDiffsStream

java.io.InputStream getChangelistDiffsStream(int id,
                                             DescribeOptions options)
                                      throws ConnectionException,
                                             RequestException,
                                             AccessException

Get an InputStream onto the file diffs associated with a specific submitted changelist. This method (like the similar "p4 describe" command) will not return diffs for pending changelists.

This is one of the guaranteed "live" method on this interface, and will return the diff output as it exists when called (rather than when the underlying implementation object was created). This can be an expensive method to evaluate, and can generate reams and reams (and reams) of output, so don't use it willy-nilly.

Note that unlike the corresponding command-line command, which keeps going in the face of errors by moving on to the next file (or whatever), any errors encountered in this method will cause an exception from this method at the first error, so plan accordingly....

Parameters:

id - the ID of the target changelist

options - DescribeOptions behavioural options for method.

Returns:

InputStream onto the diff stream. Note that while this stream will not be null, it may be empty

Throws:

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

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

getChangelistFiles

java.util.List<IFileSpec> getChangelistFiles(int id)
                                      throws ConnectionException,
                                             RequestException,
                                             AccessException

Get a list of the Perforce depot files associated with a Perforce changelist.

The IFileSpec objects returned are not guaranteed to have any fields except depot path, version, and action valid.

Changelists that are pending will not have files visible through this method; you should use the client openedFiles method for retrieving files in that situation.

Parameters:

id - numeric changelist identifier

Returns:

non-null (but possibly empty) list of files associated with the changelist.

Throws:

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

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

getChangelistFiles

java.util.List<IFileSpec> getChangelistFiles(int id,
                                             int max)
                                      throws ConnectionException,
                                             RequestException,
                                             AccessException

Get a list of the Perforce depot files associated with a Perforce changelist.

The IFileSpec objects returned are not guaranteed to have any fields except depot path, version, and action valid.

Changelists that are pending will not have files visible through this method; you should use the client openedFiles method for retrieving files in that situation.

Parameters:

id - numeric changelist identifier

max - limit the number of files returned

Returns:

non-null (but possibly empty) list of files associated with the changelist.

Throws:

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

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

Since:

2017.2

getChangelistExtendedFiles

java.util.List<IExtendedFileSpec> getChangelistExtendedFiles(int id)
                                                      throws ConnectionException,
                                                             RequestException,
                                                             AccessException

Get an extended list of the Perforce depot files associated with a Perforce changelist.

The IExtendedFileSpec objects returned are not guaranteed to have any fields except depot path, version, and action valid.

Changelists that are pending will not have files visible through this method; you should use the client openedFiles method for retrieving files in that situation.

Parameters:

id - numeric changelist identifier

Returns:

non-null (but possibly empty) list of extended files associated with the changelist.

Throws:

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

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

getChangelistExtendedFiles

java.util.List<IExtendedFileSpec> getChangelistExtendedFiles(int id,
                                                             int max)
                                                      throws ConnectionException,
                                                             RequestException,
                                                             AccessException

Get an extended list of the Perforce depot files associated with a Perforce changelist.

The IExtendedFileSpec objects returned are not guaranteed to have any fields except depot path, version, and action valid.

Changelists that are pending will not have files visible through this method; you should use the client openedFiles method for retrieving files in that situation.

Parameters:

id - numeric changelist identifier

max - limit the number of files returned

Returns:

non-null (but possibly empty) list of extended files associated with the changelist.

Throws:

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

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

Since:

2017.2

getShelvedFiles

java.util.List<IFileSpec> getShelvedFiles(int changelistId)
                                   throws P4JavaException

Get a list of shelved files associated with a Perforce pending changelist.

Parameters:

changelistId - numeric pending changelist identifier

Returns:

non-null (but possibly empty) list of shelved files associated with the pending changelist.

Throws:

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

Since:

2014.1

getShelvedFiles

java.util.List<IFileSpec> getShelvedFiles(int changelistId,
                                          int max)
                                   throws P4JavaException

Get a list of shelved files associated with a Perforce pending changelist.

Parameters:

changelistId - numeric pending changelist identifier

max - limit the number of files returned

Returns:

non-null (but possibly empty) list of shelved files associated with the pending changelist.

Throws:

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

Since:

2017.2