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 LoginOptions

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

public class LoginOptions
extends Options

Options subclass for IOptionsServer.login.

Field Summary
protected  boolean allHosts
          If true, the ticket is valid on all hosts; corresponds to -a flag.
protected  boolean dontWriteTicket
          If true, don't write the ticket to file; corresponds to -p flag.
protected  String host
          If not null, causes the server to issue a ticket that is valid on the specified host (IP address).
static String OPTIONS_SPECS
          Options: -a, -p, -h[host]
 
Fields inherited from class com.perforce.p4java.option.Options
immutable, optionList, OPTPFX
 
Constructor Summary
LoginOptions()
          Default constructor.
LoginOptions(boolean allHosts)
          Explicit-value constructor.
LoginOptions(boolean allHosts, boolean dontWriteTicket)
          Explicit-value constructor.
LoginOptions(boolean allHosts, boolean dontWriteTicket, String host)
          Explicit-value constructor.
LoginOptions(String... options)
          Strings-based constructor; see 'p4 help [command]' for possible options.
 
Method Summary
 String getHost()
           
 boolean isAllHosts()
           
 boolean isDontWriteTicket()
           
 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.
 LoginOptions setAllHosts(boolean allHosts)
           
 LoginOptions setDontWriteTicket(boolean dontWriteTicket)
           
 LoginOptions setHost(String host)
           
 
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: -a, -p, -h[host]

See Also:
Constant Field Values

allHosts

protected boolean allHosts
If true, the ticket is valid on all hosts; corresponds to -a flag.

dontWriteTicket

protected boolean dontWriteTicket
If true, don't write the ticket to file; corresponds to -p flag.

host

protected String host
If not null, causes the server to issue a ticket that is valid on the specified host (IP address). This flag can only be used when the login request is for another user. Corresponds to -h flag.

Constructor Detail

LoginOptions

public LoginOptions()
Default constructor.

LoginOptions

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

LoginOptions

public LoginOptions(boolean allHosts)
Explicit-value constructor.

Parameters:
allHosts -

LoginOptions

public LoginOptions(boolean allHosts,
                    boolean dontWriteTicket)
Explicit-value constructor.

Parameters:
allHosts -
dontWriteTicket -

LoginOptions

public LoginOptions(boolean allHosts,
                    boolean dontWriteTicket,
                    String host)
Explicit-value constructor.

Parameters:
allHosts -
dontWriteTicket -
host -
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)

isAllHosts

public boolean isAllHosts()

setAllHosts

public LoginOptions setAllHosts(boolean allHosts)

isDontWriteTicket

public boolean isDontWriteTicket()

setDontWriteTicket

public LoginOptions setDontWriteTicket(boolean dontWriteTicket)

getHost

public String getHost()

setHost

public LoginOptions setHost(String host)
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.