Package com.perforce.p4java.option.server

Class GetUsersOptions

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -m[max], -l, -a
        See Also:
        Constant Field Values

      • maxUsers

        protected int maxUsers
        If positive, return only the first maxUsers users. Corresponds to the -m flag.

      • includeServiceUsers

        protected boolean includeServiceUsers
        If true, include service users in the returned list; corresponds to the -a flag.
        Since:
        2011.1

      • extendedOutput

        protected boolean extendedOutput
        If true, include additional information in the output; corresponds to the -l flag.
        Since:
        2011.1

    • Constructor Detail

      • GetUsersOptions

        public GetUsersOptions()
        Default constructor.

      • GetUsersOptions

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

      • GetUsersOptions

        public GetUsersOptions​(int maxUsers)
        Explicit-value constructor.
        Parameters:
        maxUsers - maxUsers

      • GetUsersOptions

        public GetUsersOptions​(int maxUsers,
                       boolean includeServiceUsers,
                       boolean extendedOutput)
        Explicit-value constructor.
        Parameters:
        maxUsers - maxUsers
        includeServiceUsers - includeServiceUsers
        extendedOutput - extendedOutput
        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)

      • getMaxUsers

        public int getMaxUsers()

      • isIncludeServiceUsers

        public boolean isIncludeServiceUsers()
        Returns:
        result
        Since:
        2011.1

      • setIncludeServiceUsers

        public GetUsersOptions setIncludeServiceUsers​(boolean includeServiceUsers)
        Parameters:
        includeServiceUsers - option
        Returns:
        result
        Since:
        2011.1

      • isExtendedOutput

        public boolean isExtendedOutput()
        Returns:
        result
        Since:
        2011.1

      • setExtendedOutput

        public GetUsersOptions setExtendedOutput​(boolean extendedOutput)
        Parameters:
        extendedOutput - option
        Returns:
        result
        Since:
        2011.1