Package com.perforce.p4java.option.server

Class GetFileContentsOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -a, -q, -T, --offset, --size
        See Also:
        Constant Field Values

      • OPTION_SPEC_NEW

        public static final java.lang.String OPTION_SPEC_NEW
        Options: --offset, --size
        See Also:
        Constant Field Values

      • 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 java.lang.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 Detail

      • GetFileContentsOptions

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

      • GetFileContentsOptions

        public GetFileContentsOptions​(java.lang.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:
        Options(java.lang.String...)

      • GetFileContentsOptions

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

    • Method Detail

      • processOptions

        public java.util.List<java.lang.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:
        Options.processOptions(com.perforce.p4java.server.IServer)

      • isAllrevs

        public boolean isAllrevs()

      • isNoHeaderLine

        public boolean isNoHeaderLine()

      • isDontAnnotateFiles

        public boolean isDontAnnotateFiles()

      • getFileAttributeName

        public java.lang.String getFileAttributeName()

      • setFileAttributeName

        public GetFileContentsOptions setFileAttributeName​(java.lang.String fileAttributeName)

      • getOffset

        public long getOffset()

      • setOffset

        public void setOffset​(long offset)

      • getSize

        public long getSize()

      • setSize

        public void setSize​(long size)