Package com.perforce.p4java.option.server

Class PropertyOptions

  • public class PropertyOptions
extends Options
    Options class for IOptionsServer's setProperty and deleteProperty methods.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String group
      If not null, use this as the user group to which this property applies.
      protected java.lang.String name
      If not null, use this as the name of this property.
      static java.lang.String OPTIONS_SPECS
      Options: -n name -v value [-s sequence] [-u user | -g group]
      protected java.lang.String sequence
      If greater than zero, use this as the sequence number of this property.
      protected java.lang.String user
      If not null, use this as the user to whom this property applies.
      protected java.lang.String value
      If not null, use this as the value of this property.

    • Constructor Summary

      Constructors 
      Constructor Description
      PropertyOptions()
      Default constructor.
      PropertyOptions​(java.lang.String... options)
      Strings-based constructor; see 'p4 help [command]' for possible options.
      PropertyOptions​(java.lang.String name, java.lang.String value, java.lang.String sequence, java.lang.String user, java.lang.String group)
      Explicit value constructor.

    • Field Detail

      • OPTIONS_SPECS

        public static final java.lang.String OPTIONS_SPECS
        Options: -n name -v value [-s sequence] [-u user | -g group]
        See Also:
        Constant Field Values

      • name

        protected java.lang.String name
        If not null, use this as the name of this property. Corresponds to the -n flag.

      • value

        protected java.lang.String value
        If not null, use this as the value of this property. Corresponds to the -v flag.

      • sequence

        protected java.lang.String sequence
        If greater than zero, use this as the sequence number of this property. If the sequence is not specified, it defaults to 1. Corresponds to the -s flag.

      • user

        protected java.lang.String user
        If not null, use this as the user to whom this property applies. Corresponds to the -u flag.

      • group

        protected java.lang.String group
        If not null, use this as the user group to which this property applies. Corresponds to the -g flag.

    • Constructor Detail

      • PropertyOptions

        public PropertyOptions()
        Default constructor.

      • PropertyOptions

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

      • PropertyOptions

        public PropertyOptions​(java.lang.String name,
                       java.lang.String value,
                       java.lang.String sequence,
                       java.lang.String user,
                       java.lang.String group)
        Explicit value constructor.
        Parameters:
        name - name
        value - value
        sequence - sequence
        user - user
        group - group

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

      • getName

        public java.lang.String getName()

      • getValue

        public java.lang.String getValue()

      • getSequence

        public java.lang.String getSequence()

      • setSequence

        public PropertyOptions setSequence​(java.lang.String sequence)

      • getUser

        public java.lang.String getUser()

      • getGroup

        public java.lang.String getGroup()