Package com.perforce.p4java.option.server

Class GetChangelistsOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -i, -l, -c[client], -m[max], -s[status], -u[user], -f, -L
        See Also:
        Constant Field Values

      • maxMostRecent

        protected int maxMostRecent
        If positive, restrict the list to the maxMostRecent most recent changelists. Corresponds to -mmax.

      • clientName

        protected java.lang.String clientName
        If non-null, restrict the results to changelists associated with the given client. Corresponds to -cclient flag.

      • userName

        protected java.lang.String userName
        If non-null, restrict the results to changelists associated with the given user name. Corresponds to -uuser flag.

      • includeIntegrated

        protected boolean includeIntegrated
        If true, also include any changelists integrated into the specified files (if any). Corresponds to -i flag.

      • type

        protected IChangelist.Type type
        If not null, restrict output to pending, shelved or submitted changelists. Corresponds to -sstatus flag.

      • longDesc

        protected boolean longDesc
        If true, produce a non-truncated long version of the description. Corresponds to the -l flag.

      • viewRestricted

        protected boolean viewRestricted
        If true, enables admins to see restricted changes. Corresponds to -f flag.

      • truncateDescriptions

        protected boolean truncateDescriptions
        If true, truncate the changelist descriptions to 250 characters if longer; corresponds to -L.
        Since:
        2011.1

    • Constructor Detail

      • GetChangelistsOptions

        public GetChangelistsOptions()
        Default constructor.

      • GetChangelistsOptions

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

      • GetChangelistsOptions

        public GetChangelistsOptions​(int maxMostRecent,
                             java.lang.String clientName,
                             java.lang.String userName,
                             boolean includeIntegrated,
                             IChangelist.Type type,
                             boolean longDesc)
        Explicit-value constructor.
        Parameters:
        maxMostRecent - maxMostRecent
        clientName - clientName
        userName - userName
        includeIntegrated - includeIntegrated
        type - type
        longDesc - longDesc

      • GetChangelistsOptions

        public GetChangelistsOptions​(int maxMostRecent,
                             java.lang.String clientName,
                             java.lang.String userName,
                             boolean includeIntegrated,
                             IChangelist.Type type,
                             boolean longDesc,
                             boolean viewRestricted)
        Explicit-value constructor.
        Parameters:
        maxMostRecent - maxMostRecent
        clientName - clientName
        userName - userName
        includeIntegrated - includeIntegrated
        type - type
        longDesc - longDesc
        viewRestricted - viewRestricted

      • GetChangelistsOptions

        public GetChangelistsOptions​(int maxMostRecent,
                             java.lang.String clientName,
                             java.lang.String userName,
                             boolean includeIntegrated,
                             IChangelist.Type type,
                             boolean longDesc,
                             boolean viewRestricted,
                             boolean truncateDescriptions)
        Explicit-value constructor.
        Parameters:
        maxMostRecent - maxMostRecent
        clientName - clientName
        userName - userName
        includeIntegrated - includeIntegrated
        type - type
        longDesc - longDesc
        viewRestricted - viewRestricted
        truncateDescriptions - truncateDescriptions
        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)

      • getMaxMostRecent

        public int getMaxMostRecent()

      • getClientName

        public java.lang.String getClientName()

      • getUserName

        public java.lang.String getUserName()

      • isIncludeIntegrated

        public boolean isIncludeIntegrated()

      • setIncludeIntegrated

        public GetChangelistsOptions setIncludeIntegrated​(boolean includeIntegrated)

      • isLongDesc

        public boolean isLongDesc()

      • isViewRestricted

        public boolean isViewRestricted()

      • isTruncateDescriptions

        public boolean isTruncateDescriptions()
        Returns:
        true if description is truncated
        Since:
        2011.1

      • setTruncateDescriptions

        public GetChangelistsOptions setTruncateDescriptions​(boolean truncateDescriptions)
        Parameters:
        truncateDescriptions - truncate option
        Returns:
        GetChangelistsOptions class
        Since:
        2011.1