public class GetFileContentsOptions extends Options
Modifier and Type | Field and Description |
---|---|
protected boolean |
allrevs
If true, get the contents of all revisions within the specific range, rather
than just the highest revision in the range.
|
protected boolean |
dontAnnotateFiles
If true, don't append revision specifiers (# and @) to the filespecs
(Parameters.processParameters(...)).
|
protected boolean |
noHeaderLine
If true, suppress the initial line that displays the file name and revision.
|
protected long |
offset
Skip the specified number of bytes and only print what follows.
|
static java.lang.String |
OPTION_SPEC_NEW
Options: --offset, --size
|
static java.lang.String |
OPTIONS_SPECS
Options: -a, -q, --offset, --size
|
protected long |
size
Print the specified number of bytes from the offset.
|
immutable, optionList
Constructor and Description |
---|
GetFileContentsOptions()
Default constructor -- sets all fields to false.
|
GetFileContentsOptions(boolean allrevs,
boolean noHeaderLine)
Explicit-value constructor.
|
GetFileContentsOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
long |
getOffset() |
long |
getSize() |
boolean |
isAllrevs() |
boolean |
isDontAnnotateFiles() |
boolean |
isNoHeaderLine() |
java.util.List<java.lang.String> |
processOptions(IServer server)
Turn this (specific) options object into a list of strings to be sent to
the Perforce server as options for a specific command.
|
GetFileContentsOptions |
setAllrevs(boolean allrevs) |
GetFileContentsOptions |
setDontAnnotateFiles(boolean dontAnnotateFiles) |
GetFileContentsOptions |
setNoHeaderLine(boolean noHeaderLine) |
void |
setOffset(long offset) |
void |
setSize(long size) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
public static final java.lang.String OPTION_SPEC_NEW
protected boolean allrevs
protected boolean noHeaderLine
protected boolean dontAnnotateFiles
Note that this is not a standard option for this command. It is merely a convenience flag to tell the parameter processor not to include revisions with the filespecs.
protected long offset
protected long size
public GetFileContentsOptions()
public GetFileContentsOptions(java.lang.String... options)
WARNING: you should not pass more than one option or argument in each string parameter. Each option or argument should be passed-in as its own separate string parameter, without any spaces between the option and the option value (if any).
NOTE: setting options this way always bypasses the internal options values, and getter methods against the individual values corresponding to the strings passed in to this constructor will not normally reflect the string's setting. Do not use this constructor unless you know what you're doing and / or you do not also use the field getters and setters.
options
- optionsOptions(java.lang.String...)
public GetFileContentsOptions(boolean allrevs, boolean noHeaderLine)
allrevs
- allrevsnoHeaderLine
- noHeaderLinepublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
The method is used by the server object to generate the string-based arguments expected by the Perforce server corresponding to the state of this method-specific options object. Will return an empty list if there are no "interesting" options set or available. May simply return the superclass options string list if is non-null, but that behaviour is neither guaranteed nor required.
Note that this method is not intended to be called directly by users but by the underlying P4Java plumbing; odd results may occur if this method is called in other contexts.
processOptions
in class Options
server
- possibly-null IServer representing the Perforce server the
options are to be used against. If this parameter is null, it
is acceptable to throw an OptionsException, but it is also
possible to ignore it and do the best you can with what you've
got...OptionsException
- if an error occurs in options processing that is not some
species of ConnectionException, RequestException,
AccessException, etc.Options.processOptions(com.perforce.p4java.server.IServer)
public boolean isAllrevs()
public GetFileContentsOptions setAllrevs(boolean allrevs)
public boolean isNoHeaderLine()
public GetFileContentsOptions setNoHeaderLine(boolean noHeaderLine)
public boolean isDontAnnotateFiles()
public GetFileContentsOptions setDontAnnotateFiles(boolean dontAnnotateFiles)
public long getOffset()
public void setOffset(long offset)
public long getSize()
public void setSize(long size)