Package com.perforce.p4java.option.server

Class GetDepotsOptions

  • public class GetDepotsOptions
extends Options

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        p4 depots [-t type] [[-e|-E] nameFilter]
        See Also:
        Constant Field Values

      • type

        protected IDepot.DepotType type
        If not-null, limits qualifying depots to those matching type.

      • nameFilter

        protected java.lang.String nameFilter
        If not-null, limits qualifying depots to those matching the nameFilter pattern.

      • caseInsensitiveNameFilter

        protected java.lang.String caseInsensitiveNameFilter
        If non-null, limits output to depots whose name matches (case-insensitive) the nameFilter pattern. Corresponds to -EnameFilter flag

    • Constructor Detail

      • GetDepotsOptions

        public GetDepotsOptions()
        Default constructor; sets all fields to null, zero, or false.

      • GetDepotsOptions

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

    • Method Detail

      • processOptions

        public java.util.List<java.lang.String> processOptions​(IServer server)
                                                throws OptionsException
        Explicit-value constructor.
        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.

      • getNameFilter

        public java.lang.String getNameFilter()

      • getCaseInsensitiveNameFilter

        public java.lang.String getCaseInsensitiveNameFilter()

      • setNameFilter

        public GetDepotsOptions setNameFilter​(java.lang.String nameFilter)

      • setCaseInsensitiveNameFilter

        public void setCaseInsensitiveNameFilter​(java.lang.String caseInsensitiveNameFilter)