public enum ConnectionPreference extends java.lang.Enum<ConnectionPreference>
toString()
, a user-friendly name and
description, and a default string value for each preference.Enum Constant and Description |
---|
ConnectionID
The ID associated with the current VisIt connection.
|
DataType
The type or data or method used to send VisIt render information over the
network.
|
Host
The host machine that will run VisIt.
|
HostPort
The port on the host over which VisIt will be served.
|
LaunchInstance
Whether to launch a new VisIt instance or connect to an existing one.
|
Proxy
The machine through which the client will connect to the host.
|
ProxyPort
The port on the proxy to which the client will connect to the host.
|
SessionPassword
The password used to connect to the running VisIt instance.
|
SessionUser
The user name for the running VisIt instance.
|
UseTunneling
Whether to use tunneling when connecting to the host.
|
VisItPath
The path to the VisIt installation on the host machine.
|
WindowHeight
The height of the view on the client.
|
WindowID
The ID associated with the VisIt view to display.
|
WindowWidth
The width of the view on the client.
|
Modifier and Type | Method and Description |
---|---|
static ConnectionPreference |
fromID(java.lang.String id)
Converts a string ID to an enum value.
|
java.lang.String |
getDefaultValue()
Gets the default value for the connection preference.
|
java.lang.String |
getDescription()
Gets the user-friendly description for the connection preference.
|
java.lang.String |
getID()
Gets the VisIt-widget-friendly ID for the connection preference.
|
java.lang.String |
getName()
Gets the user-friendly name for the connection preference.
|
static ConnectionPreference |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static ConnectionPreference[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ConnectionPreference ConnectionID
public static final ConnectionPreference Host
public static final ConnectionPreference HostPort
public static final ConnectionPreference VisItPath
public static final ConnectionPreference LaunchInstance
public static final ConnectionPreference UseTunneling
public static final ConnectionPreference Proxy
public static final ConnectionPreference ProxyPort
public static final ConnectionPreference SessionUser
public static final ConnectionPreference SessionPassword
public static final ConnectionPreference DataType
public static final ConnectionPreference WindowWidth
public static final ConnectionPreference WindowHeight
public static final ConnectionPreference WindowID
public static ConnectionPreference[] values()
for (ConnectionPreference c : ConnectionPreference.values()) System.out.println(c);
public static ConnectionPreference valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String getDefaultValue()
public java.lang.String getID()
public java.lang.String getName()
public java.lang.String getDescription()
public static ConnectionPreference fromID(java.lang.String id) throws java.lang.IllegalArgumentException
HashMap
.
To convert the developer-friendly name of a preference to an enum value,
use valueOf(String)
.
id
- The VisIt-widget-friendly ID to convert.java.lang.IllegalArgumentException
- An exception is thrown if a matching enum value cannot be
found.valueOf(String)