Package com.perforce.p4java.option.server

Class GetStreamsOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -U, -F["filter"], -T["fields"], -m[max], --viewmatch
        See Also:
        Constant Field Values

      • unloaded

        protected boolean unloaded
        If true, lists unloaded task streams (see 'p4 help unload'). Corresponds to -U flag.

      • filter

        protected java.lang.String filter
        The -F filter flag limits the output to files satisfying the expression given as 'filter'. This filter expression is similar to the one used by 'jobs -e jobview', except that fields must match those above and are case sensitive.

        e.g. -F "Parent=//Ace/MAIN & Type=development"

      • fields

        protected java.lang.String fields
        The -T fields flag (used with tagged output) limits the fields output to those specified by a list given as 'fields'. These field names can be separated by a space or a comma.

        e.g. -T "Stream, Owner"

      • maxResults

        protected int maxResults
        If greater than zero, limit output to the first maxResults number of branches. Corresponds to -m flag.

      • viewmatch

        protected boolean viewmatch
        If true, Returns the stream name, depot path, and stream view path of the streams that have views containing the given depot files. Corresponds to --viewmatch flag.

    • Constructor Detail

      • GetStreamsOptions

        public GetStreamsOptions()
        Default constructor.

      • GetStreamsOptions

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

      • GetStreamsOptions

        public GetStreamsOptions​(java.lang.String filter,
                         java.lang.String fields,
                         int maxResults)
        Explicit-value constructor.
        Parameters:
        filter - filter
        fields - fields
        maxResults - maxResults

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

      • isUnloaded

        public boolean isUnloaded()

      • getFilter

        public java.lang.String getFilter()

      • getFields

        public java.lang.String getFields()

      • getMaxResults

        public int getMaxResults()

      • isViewmatch

        public boolean isViewmatch()