public class DescribeDelegator extends BaseDelegator implements IDescribeDelegator
MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION
Constructor and Description |
---|
DescribeDelegator(IOptionsServer server) |
Modifier and Type | Method and Description |
---|---|
java.io.InputStream |
getChangelistDiffs(int id,
DiffType diffType) |
java.io.InputStream |
getChangelistDiffs(int changelistId,
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> |
getCommitFiles(java.lang.String repo,
java.lang.String commit) |
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.
|
public DescribeDelegator(IOptionsServer server)
public java.io.InputStream getChangelistDiffs(int changelistId, GetChangelistDiffsOptions opts) throws P4JavaException
IDescribeDelegator
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....
getChangelistDiffs
in interface IDescribeDelegator
changelistId
- the ID of the target changelist.opts
- GetChangelistDiffsOptions object describing optional
parameters; if null, no options are set.P4JavaException
- if any error occurs in the processing of this method.public java.io.InputStream getChangelistDiffsStream(int id, DescribeOptions options) throws ConnectionException, RequestException, AccessException
IDescribeDelegator
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....
getChangelistDiffsStream
in interface IDescribeDelegator
id
- the ID of the target changelistoptions
- DescribeOptions behavioural options for method.ConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.util.List<IFileSpec> getShelvedFiles(int changelistId) throws P4JavaException
IDescribeDelegator
getShelvedFiles
in interface IDescribeDelegator
changelistId
- numeric pending changelist identifierP4JavaException
- if an error occurs processing this method and its parameters.public java.util.List<IFileSpec> getShelvedFiles(int changelistId, int max) throws P4JavaException
IDescribeDelegator
getShelvedFiles
in interface IDescribeDelegator
changelistId
- numeric pending changelist identifiermax
- limit the number of files returnedP4JavaException
- if an error occurs processing this method and its parameters.public java.io.InputStream getChangelistDiffs(int id, DiffType diffType) throws ConnectionException, RequestException, AccessException
public java.util.List<IFileSpec> getChangelistFiles(int id) throws ConnectionException, RequestException, AccessException
IDescribeDelegator
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.
getChangelistFiles
in interface IDescribeDelegator
id
- numeric changelist identifierConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.util.List<IFileSpec> getChangelistFiles(int id, int max) throws ConnectionException, RequestException, AccessException
IDescribeDelegator
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.
getChangelistFiles
in interface IDescribeDelegator
id
- numeric changelist identifiermax
- limit the number of files returnedConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.util.List<IExtendedFileSpec> getChangelistExtendedFiles(int id) throws ConnectionException, RequestException, AccessException
IDescribeDelegator
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.
getChangelistExtendedFiles
in interface IDescribeDelegator
id
- numeric changelist identifierConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.util.List<IExtendedFileSpec> getChangelistExtendedFiles(int id, int max) throws ConnectionException, RequestException, AccessException
IDescribeDelegator
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.
getChangelistExtendedFiles
in interface IDescribeDelegator
id
- numeric changelist identifiermax
- limit the number of files returnedConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.util.List<IFileSpec> getCommitFiles(java.lang.String repo, java.lang.String commit) throws ConnectionException, RequestException, AccessException