Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.perforce.p4java.option.server
Class TrustOptions

java.lang.Object
  extended by com.perforce.p4java.option.Options
      extended by com.perforce.p4java.option.server.TrustOptions

public class TrustOptions
extends Options

Options class for the Perforce IOptionsServer.addTrust method.

Field Summary
protected  boolean autoAccept
          Like no option but prompting automatically accepted.
protected  boolean autoRefuse
          Like no option but prompting automatically refused.
protected  boolean force
          Forcibly install fingerprint even if differs.
static String OPTIONS_SPECS
          Options: -f, -n, -y, -r.
protected  boolean replacement
          Specifies that a replacement fingerprint is to be affected.
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
TrustOptions()
          Default constructor.
TrustOptions(boolean force, boolean autoRefuse, boolean autoAccept)
          Creates a new TrustOptions object, given the 'force', 'autoRefuse' and 'autoAccept' flags.
TrustOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 boolean isAutoAccept()
          Checks if is to automatically accept yes/no prompting.
 boolean isAutoRefuse()
          Checks if is true/false to automatically refuse yes/no prompting.
 boolean isForce()
          Checks if is true/false to forcibly install fingerprint.
 boolean isReplacement()
          Checks if a replacement fingerprint is to be affected.
 List<String> processOptions(IServer server)
          Turn this (specific) options object into a list of strings to be sent to the Perforce server as options for a specific command.
 TrustOptions setAutoAccept(boolean autoAccept)
          Sets true/false to automatically accept yes/no prompting.
 TrustOptions setAutoRefuse(boolean autoRefuse)
          Sets true/false to automatically refuse yes/no prompting.
 TrustOptions setForce(boolean force)
          Sets true/false to forcibly install fingerprint.
 TrustOptions setReplacement(boolean replacement)
          Sets true/false that a replacement fingerprint is to be affected
 
Methods inherited from class com.perforce.p4java.option.Options
applyRule, applyRule, applyRule, applyRule, getOptions, isImmutable, processFields, setImmutable, setOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTIONS_SPECS

public static final String OPTIONS_SPECS
Options: -f, -n, -y, -r.

See Also:
Constant Field Values

force

protected boolean force
Forcibly install fingerprint even if differs. Corresponds to the -f flag.

autoRefuse

protected boolean autoRefuse
Like no option but prompting automatically refused. Corresponds to the -n flag.

autoAccept

protected boolean autoAccept
Like no option but prompting automatically accepted. Corresponds to the -y flag.

replacement

protected boolean replacement
Specifies that a replacement fingerprint is to be affected. Corresponds to the -r flag.

Constructor Detail

TrustOptions

public TrustOptions()
Default constructor.

TrustOptions

public TrustOptions(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.

See Also:
Options.Options(java.lang.String...)

TrustOptions

public TrustOptions(boolean force,
                    boolean autoRefuse,
                    boolean autoAccept)
Creates a new TrustOptions object, given the 'force', 'autoRefuse' and 'autoAccept' flags.

Parameters:
force - true/false to forcibly install fingerprint
autoRefuse - true/false to automatically refuse yes/no prompting
autoAccept - true/false to automatically accept yes/no prompting
Method Detail

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:
Options.processOptions(com.perforce.p4java.server.IServer)

isForce

public boolean isForce()
Checks if is true/false to forcibly install fingerprint.

Returns:
true, if is to forcibly install fingerprint

setForce

public TrustOptions setForce(boolean force)
Sets true/false to forcibly install fingerprint.

Parameters:
force - true/false to forcibly install fingerprint.
Returns:
the trust options

isAutoRefuse

public boolean isAutoRefuse()
Checks if is true/false to automatically refuse yes/no prompting.

Returns:
true, if is to automatically refuse yes/no prompting

setAutoRefuse

public TrustOptions setAutoRefuse(boolean autoRefuse)
Sets true/false to automatically refuse yes/no prompting.

Parameters:
autoRefuse - true/false to automatically refuse yes/no prompting
Returns:
the trust options

isAutoAccept

public boolean isAutoAccept()
Checks if is to automatically accept yes/no prompting.

Returns:
true, if is to automatically accept yes/no prompting

setAutoAccept

public TrustOptions setAutoAccept(boolean autoAccept)
Sets true/false to automatically accept yes/no prompting.

Parameters:
autoAccept - true/false to automatically accept yes/no prompting
Returns:
the trust options

isReplacement

public boolean isReplacement()
Checks if a replacement fingerprint is to be affected.

Returns:
true, if a replacement fingerprint is to be affected

setReplacement

public TrustOptions setReplacement(boolean replacement)
Sets true/false that a replacement fingerprint is to be affected

Parameters:
replacement - true/false that a replacement fingerprint is to be affected.
Returns:
the trust options
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2015 Perforce Software. All Rights Reserved.