Package com.perforce.p4java.option.server

Class GetProtectionEntriesOptions

java.lang.Object
com.perforce.p4java.option.Options
com.perforce.p4java.option.server.GetProtectionEntriesOptions
public class GetProtectionEntriesOptions extends Options
Options subclass for the IOptionsServer.getProtectionEntries method.
See Also:

  • Field Details

    • OPTIONS_SPECS

      public static final String OPTIONS_SPECS
      Options: -a, -g[group], -u[user], -h[host], -m
      See Also:

    • allUsers

      protected boolean allUsers
      If true,protection lines for all users are displayed; corresponds to the -a flag.

    • hostName

      protected String hostName
      If not null, only those protection lines that apply to the given host (IP address) are displayed; corresponds to the -h flag.

    • userName

      protected String userName
      If not null, protection lines for the named user are displayed; -u flag

    • groupName

      protected String groupName
      If not null, protection lines for the named group are displayed; -g flag

    • singleWordSummary

      protected boolean singleWordSummary
      If not null, a single word summary of the maximum access level is reported; -m flag

  • Constructor Details

    • GetProtectionEntriesOptions

      public GetProtectionEntriesOptions()
      Default constructor.

    • GetProtectionEntriesOptions

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

    • GetProtectionEntriesOptions

      public GetProtectionEntriesOptions(boolean allUsers, String hostName, String userName, String groupName)
      Explicit-value constructor.
      Parameters:
      allUsers - allUsers
      hostName - hostName
      userName - userName
      groupName - groupName

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

    • isAllUsers

      public boolean isAllUsers()

    • setAllUsers

      public GetProtectionEntriesOptions setAllUsers(boolean allUsers)

    • getHostName

      public String getHostName()

    • setHostName

      public GetProtectionEntriesOptions setHostName(String hostName)

    • getUserName

      public String getUserName()

    • setUserName

      public GetProtectionEntriesOptions setUserName(String userName)

    • getGroupName

      public String getGroupName()

    • setGroupName

      public GetProtectionEntriesOptions setGroupName(String groupName)

    • isSingleWordSummary

      public boolean isSingleWordSummary()

    • setSingleWordSummary

      public GetProtectionEntriesOptions setSingleWordSummary(boolean singleWordSummary)