public class LoginOptions extends Options
Modifier and Type | Field and Description |
---|---|
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 java.lang.String |
host
If not null, causes the server to issue a ticket that is valid on the
specified host (IP address).
|
static java.lang.String |
OPTIONS_SPECS
Options: -a, -p, -h[host]
|
protected boolean |
twoFactor |
immutable, optionList
Constructor and Description |
---|
LoginOptions()
Default constructor.
|
LoginOptions(boolean allHosts)
Explicit-value constructor.
|
LoginOptions(boolean allHosts,
boolean dontWriteTicket)
Explicit-value constructor.
|
LoginOptions(boolean allHosts,
boolean dontWriteTicket,
java.lang.String host)
Explicit-value constructor.
|
LoginOptions(java.lang.String... options)
Strings-based constructor; see 'p4 help [command]' for possible options.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getHost() |
boolean |
isAllHosts() |
boolean |
isDontWriteTicket() |
boolean |
isTwoFactor() |
java.util.List<java.lang.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(java.lang.String host) |
LoginOptions |
setTwoFactor(boolean twoFactor) |
getOptions, isImmutable, processFields, setImmutable, setOptions
public static final java.lang.String OPTIONS_SPECS
protected boolean allHosts
protected boolean dontWriteTicket
protected java.lang.String host
protected boolean twoFactor
public LoginOptions()
public LoginOptions(java.lang.String... 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.
options
- optionsOptions(java.lang.String...)
public LoginOptions(boolean allHosts)
allHosts
- allHostspublic LoginOptions(boolean allHosts, boolean dontWriteTicket)
allHosts
- allHostsdontWriteTicket
- dontWriteTicketpublic LoginOptions(boolean allHosts, boolean dontWriteTicket, java.lang.String host)
allHosts
- allHostsdontWriteTicket
- dontWriteTickethost
- hostpublic java.util.List<java.lang.String> processOptions(IServer server) throws OptionsException
Options
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.
processOptions
in class Options
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...OptionsException
- if an error occurs in options processing that is not some
species of ConnectionException, RequestException,
AccessException, etc.Options.processOptions(com.perforce.p4java.server.IServer)
public boolean isAllHosts()
public LoginOptions setAllHosts(boolean allHosts)
public boolean isDontWriteTicket()
public LoginOptions setDontWriteTicket(boolean dontWriteTicket)
public java.lang.String getHost()
public LoginOptions setHost(java.lang.String host)
public boolean isTwoFactor()
public LoginOptions setTwoFactor(boolean twoFactor)