Package com.perforce.p4java.option.server

Class GetFileContentsOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetFileContentsOptions
public class GetFileContentsOptions extends Options
Options class for the IOptionsServer.getFileContents method.
See Also:

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -a, -q, -T, --offset, --size
      See Also:

    • OPTION_SPEC_NEW

      public static final String OPTION_SPEC_NEW
      Options: --offset, --size
      See Also:

    • allrevs

      protected boolean allrevs
      If true, get the contents of all revisions within the specific range, rather than just the highest revision in the range. Corresponds to -a.

    • noHeaderLine

      protected boolean noHeaderLine
      If true, suppress the initial line that displays the file name and revision. Corresponds to -q.

    • dontAnnotateFiles

      protected boolean dontAnnotateFiles
      If true, don't append revision specifiers (# and @) to the filespecs (Parameters.processParameters(...)). By default the filespecs passed to IOptionsServer.getFileContents() would get revisions appended to them during parameter processing.

      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.

    • fileAttributeName

      protected String fileAttributeName
      The -T option prints the value of the specified non-encoded attribute of the specified file.

    • offset

      protected long offset
      Skip the specified number of bytes and only print what follows.

    • size

      protected long size
      Print the specified number of bytes from the offset.

  • Constructor Details

    • GetFileContentsOptions

      public GetFileContentsOptions()
      Default constructor -- sets all fields to false.

    • GetFileContentsOptions

      public GetFileContentsOptions(String... options)
      Strings-based constructor; see 'p4 help [command]' for possible 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.

      Parameters:
      options - options
      See Also:

    • GetFileContentsOptions

      public GetFileContentsOptions(boolean allrevs, boolean noHeaderLine)
      Explicit-value constructor.
      Parameters:
      allrevs - allrevs
      noHeaderLine - noHeaderLine

  • Method Details

    • processOptions

      public List<String> processOptions(IServer server) throws OptionsException
      Description copied from class: Options
      Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command. As a side effect, set the option list associated with this Option to the result.

      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.

      Specified by:
      processOptions in class Options
      Parameters:
      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...
      Returns:
      non-null (but possibly empty) string list representing the normalized Perforce server arguments corresponding to the state of this specific options object.
      Throws:
      OptionsException - if an error occurs in options processing that is not some species of ConnectionException, RequestException, AccessException, etc.
      See Also:

    • isAllrevs

      public boolean isAllrevs()

    • setAllrevs

      public GetFileContentsOptions setAllrevs(boolean allrevs)

    • isNoHeaderLine

      public boolean isNoHeaderLine()

    • setNoHeaderLine

      public GetFileContentsOptions setNoHeaderLine(boolean noHeaderLine)

    • isDontAnnotateFiles

      public boolean isDontAnnotateFiles()

    • setDontAnnotateFiles

      public GetFileContentsOptions setDontAnnotateFiles(boolean dontAnnotateFiles)

    • getFileAttributeName

      public String getFileAttributeName()

    • setFileAttributeName

      public GetFileContentsOptions setFileAttributeName(String fileAttributeName)

    • getOffset

      public long getOffset()

    • setOffset

      public void setOffset(long offset)

    • getSize

      public long getSize()

    • setSize

      public void setSize(long size)