Package com.perforce.p4java.option.server

Class GetExtendedFilesOptions

  • public class GetExtendedFilesOptions
extends Options
    Options class for the IOptionsServer getExtendedFiles (a.k.a. "fstat") method.

    The various options are too complex to be described in a few sentences here, and the various option arguments reflect this complexity. Note also that several options below (e.g. the "-F" equivalent) may only be available for later-model servers; use of these with earlier servers will typically cause RequestExceptions from the server (at least). Note further that no attempt is made with the default implementation here to sanity check the complex set of options for consistency.

    Please consult the main p4 documentation for detailed options semantics and option / server compatibility details.

    See Also:
    IFstatDelegator.getExtendedFiles(java.util.List, com.perforce.p4java.option.server.GetExtendedFilesOptions)

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -F[filter], -m[max], -r, -c, -e[changelist], -O[x], -R[x], -S[x], -A[pattern]

        NOTE: the -O[x] and -R[x] options are not processed using the OPTIONS_SPEC string.

        See Also:
        Constant Field Values

      • filterString

        protected java.lang.String filterString
        -F

      • maxResults

        protected int maxResults
        -m

      • reverseSort

        protected boolean reverseSort
        -r

      • sinceChangelist

        protected int sinceChangelist
        -c

      • affectedByChangelist

        protected int affectedByChangelist
        -e

      • sortByFiletype

        protected boolean sortByFiletype
        -St

      • sortByDate

        protected boolean sortByDate
        -Sd

      • sortByHeadRev

        protected boolean sortByHeadRev
        -Sr

      • sortByHaveRev

        protected boolean sortByHaveRev
        -Sh

      • sortByFileSize

        protected boolean sortByFileSize
        -Ss

      • attributePattern

        protected java.lang.String attributePattern
        fstat -A pattern (unsupported -- see 'p4 undoc' fstat entry).

    • Constructor Detail

      • GetExtendedFilesOptions

        public GetExtendedFilesOptions()
        Default constructor.

      • GetExtendedFilesOptions

        public GetExtendedFilesOptions​(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...)

      • GetExtendedFilesOptions

        public GetExtendedFilesOptions​(java.lang.String filterString,
                               int maxResults,
                               boolean reverseSort,
                               int sinceChangelist,
                               int affectedByChangelist,
                               boolean sortByFiletype,
                               boolean sortByDate,
                               boolean sortByHeadRev,
                               boolean sortByHaveRev,
                               boolean sortByFileSize,
                               FileStatOutputOptions outputOptions,
                               FileStatAncilliaryOptions ancilliaryOptions)
        Explicit-value constructor (release 2010.1).
        Parameters:
        filterString - filterString
        maxResults - maxResults
        reverseSort - reverseSort
        sinceChangelist - sinceChangelist
        affectedByChangelist - affectedByChangelist
        sortByFiletype - sortByFiletype
        sortByDate - sortByDate
        sortByHeadRev - sortByHeadRev
        sortByHaveRev - sortByHaveRev
        sortByFileSize - sortByFileSize
        outputOptions - outputOptions
        ancilliaryOptions - ancilliaryOptions

      • GetExtendedFilesOptions

        public GetExtendedFilesOptions​(java.lang.String filterString,
                               int maxResults,
                               boolean reverseSort,
                               int sinceChangelist,
                               int affectedByChangelist,
                               boolean sortByFiletype,
                               boolean sortByDate,
                               boolean sortByHeadRev,
                               boolean sortByHaveRev,
                               boolean sortByFileSize,
                               FileStatOutputOptions outputOptions,
                               FileStatAncilliaryOptions ancilliaryOptions,
                               java.lang.String attributePattern)
        Explicit-value constructor.
        Parameters:
        filterString - filterString
        maxResults - maxResults
        reverseSort - reverseSort
        sinceChangelist - sinceChangelist
        affectedByChangelist - affectedByChangelist
        sortByFiletype - sortByFiletype
        sortByDate - sortByDate
        sortByHeadRev - sortByHeadRev
        sortByHaveRev - sortByHaveRev
        sortByFileSize - sortByFileSize
        outputOptions - outputOptions
        ancilliaryOptions - ancilliaryOptions
        attributePattern - attributePattern
        Since:
        2011.1

    • 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)

      • getFilterString

        public java.lang.String getFilterString()

      • getMaxResults

        public int getMaxResults()

      • isReverseSort

        public boolean isReverseSort()

      • getSinceChangelist

        public int getSinceChangelist()

      • getAffectedByChangelist

        public int getAffectedByChangelist()

      • isSortByFiletype

        public boolean isSortByFiletype()

      • isSortByDate

        public boolean isSortByDate()

      • isSortByHeadRev

        public boolean isSortByHeadRev()

      • isSortByHaveRev

        public boolean isSortByHaveRev()

      • isSortByFileSize

        public boolean isSortByFileSize()

      • getAttributePattern

        public java.lang.String getAttributePattern()