Package com.perforce.p4java.option.server

Class SetFileAttributesOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.SetFileAttributesOptions
public class SetFileAttributesOptions extends Options
Options class for the IOptionsServer setFileAttributes method.
Since:
2011.1

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -e, -f, -p, -T0 | -T1, I
      See Also:

    • hexValue

      protected boolean hexValue
      If true, indicates values are in hex format. Corresponds to p4's -e flag.

    • setOnSubmittedFiles

      protected boolean setOnSubmittedFiles
      If true, attributes are set on submitted files. Corresponds to -f.

    • propagateAttributes

      protected boolean propagateAttributes
      If true, creates attributes whose value will be propagated when the files are opened with 'p4 add', 'p4 edit', or 'p4 delete'. Corresponds to -p.

    • storageDbTraits

      protected boolean storageDbTraits
      If true, saves the mentioned attribute's to db.traits Corresponds to -T0

    • storageTraitsDepot

      protected boolean storageTraitsDepot
      If true, saves the mentioned attribute's to traits depot Corresponds to -T1

    • readAttributeValueFromFile

      protected String readAttributeValueFromFile
      If true, the attribute value is read from a file rather than stdin This option can't be used with the -e option

  • Constructor Details

    • SetFileAttributesOptions

      public SetFileAttributesOptions()
      Default constructor.

    • SetFileAttributesOptions

      public SetFileAttributesOptions(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:

    • SetFileAttributesOptions

      public SetFileAttributesOptions(boolean hexValue, boolean setOnSubmittedFiles, boolean propagateAttributes)
      Explicit-value constructor.
      Parameters:
      hexValue - hexValue
      setOnSubmittedFiles - setOnSubmittedFiles
      propagateAttributes - propagateAttributes

  • Method Details

    • processOptions

      public List<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:

    • isHexValue

      public boolean isHexValue()

    • setHexValue

      public SetFileAttributesOptions setHexValue(boolean hexValue)

    • isSetOnSubmittedFiles

      public boolean isSetOnSubmittedFiles()

    • setSetOnSubmittedFiles

      public SetFileAttributesOptions setSetOnSubmittedFiles(boolean setOnSubmittedFiles)

    • isPropagateAttributes

      public boolean isPropagateAttributes()

    • setPropagateAttributes

      public SetFileAttributesOptions setPropagateAttributes(boolean propagateAttributes)

    • isStorageDbTraits

      public boolean isStorageDbTraits()

    • setStorageDbTraits

      public SetFileAttributesOptions setStorageDbTraits(boolean storageDbTraits)

    • isStorageTraitsDepot

      public boolean isStorageTraitsDepot()

    • setStorageTraitsDepot

      public SetFileAttributesOptions setStorageTraitsDepot(boolean storageTraitsDepot)

    • getAttributeValueFileName

      public String getAttributeValueFileName()

    • setAttributeValueFileName

      public SetFileAttributesOptions setAttributeValueFileName(String readAttributeValueFromFile)