Package com.perforce.p4java.option.server

Class GetClientTemplateOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetClientTemplateOptions
public class GetClientTemplateOptions extends Options
Options class for IOptionsServer.getClientTemplate method.
See Also:

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -S[stream], -c[changelist]
      See Also:

    • stream

      protected String stream
      If not null, '-S stream' flag can be used with '-o -c change' to inspect an old stream client view. It yields the client spec that would have been created for the stream at the moment the change was recorded. The stream's path in a stream depot, of the form //depotname/streamname.

    • changelistId

      protected int changelistId
      If positive, it yields the client spec that would have been created for the stream at the moment the change was recorded.

    • allowExistent

      protected boolean allowExistent
      If true, return a client even if it exists. Note that this option is not processed; this option is used solely post-command-issuance in Server

  • Constructor Details

    • GetClientTemplateOptions

      public GetClientTemplateOptions()
      Default constructor.

    • GetClientTemplateOptions

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

    • GetClientTemplateOptions

      public GetClientTemplateOptions(boolean allowExistent)
      Explicit value constructor.
      Parameters:
      allowExistent - allowExistent

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

    • getStream

      public String getStream()

    • setStream

      public GetClientTemplateOptions setStream(String stream)

    • getChangelistId

      public int getChangelistId()

    • setChangelistId

      public GetClientTemplateOptions setChangelistId(int changelistId)

    • isAllowExistent

      public boolean isAllowExistent()

    • setAllowExistent

      public GetClientTemplateOptions setAllowExistent(boolean allowExistent)