Package com.perforce.p4java.option.server

Class GetRevisionHistoryOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -c[changelist], -m[max], -h, -i, -l, -L, -s
        See Also:
        Constant Field Values

      • changelistId

        protected int changelistId
        If positive, displays only files submitted at the given changelist number. Corresponds to -c#.

      • maxRevs

        protected int maxRevs
        If positive, displays at most 'maxRevs' revisions per file of the file[rev] argument specified. Corresponds to -m.

      • contentHistory

        protected boolean contentHistory
        If true, display file content history instead of file name history. Corresponds to -h.

      • includeInherited

        protected boolean includeInherited
        If true, causes inherited file history to be displayed as well. Corresponds to -i.

      • longOutput

        protected boolean longOutput
        If true, produces long output with the full text of the changelist descriptions. Corresponds to -l.

      • truncatedLongOutput

        protected boolean truncatedLongOutput
        If true, produces long output with the full text of the changelist descriptions truncated to 250 characters. Corresponds to -L.

      • omitNonContributaryIntegrations

        protected boolean omitNonContributaryIntegrations
        If true, omit non-contributory integrations; corresponds to -s.
        Since:
        2011.1

    • Constructor Detail

      • GetRevisionHistoryOptions

        public GetRevisionHistoryOptions()
        Default constructor.

      • GetRevisionHistoryOptions

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

      • GetRevisionHistoryOptions

        public GetRevisionHistoryOptions​(int changelistId,
                                 int maxRevs,
                                 boolean contentHistory,
                                 boolean includeInherited,
                                 boolean longOutput,
                                 boolean truncatedLongOutput)
        Explicit-value constructor.
        Parameters:
        changelistId - changelistId
        maxRevs - maxRevs
        contentHistory - contentHistory
        includeInherited - includeInherited
        longOutput - longOutput
        truncatedLongOutput - truncatedLongOutput

      • GetRevisionHistoryOptions

        public GetRevisionHistoryOptions​(int changelistId,
                                 int maxRevs,
                                 boolean contentHistory,
                                 boolean includeInherited,
                                 boolean longOutput,
                                 boolean truncatedLongOutput,
                                 boolean omitNonContributaryIntegrations)
        Explicit-value constructor.
        Parameters:
        changelistId - changelistId
        maxRevs - maxRevs
        contentHistory - contentHistory
        includeInherited - includeInherited
        longOutput - longOutput
        truncatedLongOutput - truncatedLongOutput
        omitNonContributaryIntegrations - omitNonContributaryIntegrations
        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)

      • getChangelistId

        public int getChangelistId()

      • getMaxRevs

        public int getMaxRevs()

      • isContentHistory

        public boolean isContentHistory()

      • isIncludeInherited

        public boolean isIncludeInherited()

      • isLongOutput

        public boolean isLongOutput()

      • isTruncatedLongOutput

        public boolean isTruncatedLongOutput()

      • isOmitNonContributaryIntegrations

        public boolean isOmitNonContributaryIntegrations()
        Returns:
        result
        Since:
        2011.1

      • setOmitNonContributaryIntegrations

        public GetRevisionHistoryOptions setOmitNonContributaryIntegrations​(boolean omitNonContributaryIntegrations)
        Parameters:
        omitNonContributaryIntegrations - option
        Returns:
        result
        Since:
        2011.1