Package com.deltawalker.script

Enum Class UriInfo.Key

java.lang.Object

java.lang.Enum<UriInfo.Key>

com.deltawalker.script.UriInfo.Key

All Implemented Interfaces:

Serializable, Comparable<UriInfo.Key>, Constable

Enclosing class:

UriInfo

public static enum UriInfo.Key
extends Enum<UriInfo.Key>

The properties a UriInfo can have. Each constant lists the property name to use in the property map passed to UriInfo(String, Map).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHARSET	The character encoding of a text file, for example "UTF-8".
EXPLICIT_MODE	Whether FTPS connections use explicit ("true") or implicit ("false") mode.
LINE_ENDING	The line ending of a text file.
LOCALE	The locale of a text file.
PASSIVE_MODE	Whether FTP connections use passive ("true") or active ("false") mode.
PASSWORD	The password for (S)FTP(S) connections.
SSH_KEY	The SSH key, for SFTP connections.
SSH_PASSPHRASE	The SSH passphrase, for SFTP connections.
USER_DIR_IS_ROOT	When "true", the user's home folder on an (S)FTP(S) server is treated as the root.
USERNAME	The user name for (S)FTP(S) connections.

Method Summary

Modifier and Type	Method	Description
static UriInfo.Key	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UriInfo.Key[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CHARSET

public static final UriInfo.Key CHARSET

The character encoding of a text file, for example "UTF-8". Property name: encoding.

EXPLICIT_MODE

public static final UriInfo.Key EXPLICIT_MODE

Whether FTPS connections use explicit ("true") or implicit ("false") mode. Property name: explicitMode.

LINE_ENDING

public static final UriInfo.Key LINE_ENDING

The line ending of a text file. Property name: lineEnding.

LOCALE

public static final UriInfo.Key LOCALE

The locale of a text file. Property name: locale.

PASSIVE_MODE

public static final UriInfo.Key PASSIVE_MODE

Whether FTP connections use passive ("true") or active ("false") mode. Property name: passiveMode.

PASSWORD

public static final UriInfo.Key PASSWORD

The password for (S)FTP(S) connections. Property name: password.

SSH_KEY

public static final UriInfo.Key SSH_KEY

The SSH key, for SFTP connections. Property name: sshKey.

SSH_PASSPHRASE

public static final UriInfo.Key SSH_PASSPHRASE

The SSH passphrase, for SFTP connections. Property name: sshPassphrase.

USER_DIR_IS_ROOT

public static final UriInfo.Key USER_DIR_IS_ROOT

When "true", the user's home folder on an (S)FTP(S) server is treated as the root. Property name: userDirIsRoot.

USERNAME

public static final UriInfo.Key USERNAME

The user name for (S)FTP(S) connections. Property name: username.

Method Details

values

public static UriInfo.Key[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UriInfo.Key valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null