public interface IDescribeDelegator
Modifier and Type | Method and Description |
---|---|
InputStream |
getChangelistDiffs(int id,
GetChangelistDiffsOptions opts)
Get an InputStream onto the file diffs associated with a specific
submitted changelist.
|
InputStream |
getChangelistDiffsStream(int id,
DescribeOptions options)
Get an InputStream onto the file diffs associated with a specific
submitted changelist.
|
List<IFileSpec> |
getShelvedFiles(int changelistId)
Get a list of shelved files associated with a Perforce pending
changelist.
|
InputStream getChangelistDiffs(int id, GetChangelistDiffsOptions opts) throws P4JavaException
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....
id
- 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.InputStream getChangelistDiffsStream(int id, DescribeOptions options) throws ConnectionException, RequestException, AccessException
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....
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 callerList<IFileSpec> getShelvedFiles(int changelistId) throws P4JavaException
changelistId
- numeric pending changelist identifierP4JavaException
- if an error occurs processing this method and its parameters.Copyright © 2017 Perforce Software. All Rights Reserved.