Package com.perforce.p4java.option.server

Class KeyOptions

  • public class KeyOptions
extends Options
    Options class for IOptionsServer's setKey method.

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -u, -d, -i
        See Also:
        Constant Field Values

      • undocKey

        protected boolean undocKey

      • delete

        protected boolean delete
        If true, delete the counter. Corresponds to the -d flag.

      • incrementKey

        protected boolean incrementKey
        If true, increment the key and return the new value. This option is used instead of a value argument and can only be used with numeric key values. Corresponds to the -i flag.

    • Constructor Detail

      • KeyOptions

        public KeyOptions()
        Default constructor.

      • KeyOptions

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

      • KeyOptions

        public KeyOptions​(boolean delete,
                  boolean incrementCounter)
        Explicit value constructor.
        Parameters:
        delete - delete
        incrementCounter - incrementCounter

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

      • isUndocKey

        public boolean isUndocKey()

      • setUndocKey

        public KeyOptions setUndocKey​(boolean undocKey)

      • isDelete

        public boolean isDelete()

      • setDelete

        public KeyOptions setDelete​(boolean delete)

      • isIncrementKey

        public boolean isIncrementKey()

      • setIncrementKey

        public KeyOptions setIncrementKey​(boolean incrementKey)