org.terracotta.angela.common

Enum AngelaProperties

java.lang.Object

java.lang.Enum<AngelaProperties>

org.terracotta.angela.common.AngelaProperties

All Implemented Interfaces:

Serializable, Comparable<AngelaProperties>

public enum AngelaProperties
extends Enum<AngelaProperties>

Listing of all system properties supported in angela

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIRECT_JOIN
DISTRIBUTION
IGNITE_LOGGING
JAVA_OPTS
JAVA_VENDOR
JAVA_VERSION
KIT_INSTALLATION_DIR
KIT_INSTALLATION_PATH
KITS_DIR
NODE_NAME
PORT_RANGE
ROOT_DIR
SKIP_KIT_COPY_LOCALHOST
SKIP_UNINSTALL
SSH_STRICT_HOST_CHECKING
SSH_USERNAME
SSH_USERNAME_KEY_PATH
TMS_FULL_LOGGING
TSA_FULL_LOGGING

Method Summary

Modifier and Type	Method and Description
void	clearProperty()
String	getDefaultValue()
static String	getEitherOf(AngelaProperties recommended, AngelaProperties deprecated) Returns the value of either the recommended or the deprecated property if the former wasn't specified.
String	getPropertyName()
String	getSpecifiedValue()
String	getValue()
void	setProperty(String value)
static AngelaProperties	valueOf(String name) Returns the enum constant of this type with the specified name.
static AngelaProperties[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROOT_DIR

public static final AngelaProperties ROOT_DIR

KIT_INSTALLATION_DIR

public static final AngelaProperties KIT_INSTALLATION_DIR

DIRECT_JOIN

public static final AngelaProperties DIRECT_JOIN

IGNITE_LOGGING

public static final AngelaProperties IGNITE_LOGGING

NODE_NAME

public static final AngelaProperties NODE_NAME

PORT_RANGE

public static final AngelaProperties PORT_RANGE

SKIP_KIT_COPY_LOCALHOST

public static final AngelaProperties SKIP_KIT_COPY_LOCALHOST

SKIP_UNINSTALL

public static final AngelaProperties SKIP_UNINSTALL

SSH_USERNAME

public static final AngelaProperties SSH_USERNAME

SSH_USERNAME_KEY_PATH

public static final AngelaProperties SSH_USERNAME_KEY_PATH

SSH_STRICT_HOST_CHECKING

public static final AngelaProperties SSH_STRICT_HOST_CHECKING

TMS_FULL_LOGGING

public static final AngelaProperties TMS_FULL_LOGGING

TSA_FULL_LOGGING

public static final AngelaProperties TSA_FULL_LOGGING

JAVA_VENDOR

public static final AngelaProperties JAVA_VENDOR

JAVA_VERSION

public static final AngelaProperties JAVA_VERSION

JAVA_OPTS

public static final AngelaProperties JAVA_OPTS

DISTRIBUTION

public static final AngelaProperties DISTRIBUTION

KITS_DIR

public static final AngelaProperties KITS_DIR

KIT_INSTALLATION_PATH

public static final AngelaProperties KIT_INSTALLATION_PATH

Method Detail

values

public static AngelaProperties[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AngelaProperties c : AngelaProperties.values())
    System.out.println(c);

Returns:

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

valueOf

public static AngelaProperties valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultValue

public String getDefaultValue()

getSpecifiedValue

public String getSpecifiedValue()

getValue

public String getValue()

getPropertyName

public String getPropertyName()

setProperty

public void setProperty(String value)

clearProperty

public void clearProperty()

getEitherOf

public static String getEitherOf(AngelaProperties recommended,
                                 AngelaProperties deprecated)

Returns the value of either the recommended or the deprecated property if the former wasn't specified. Falls back to the default value of the new property if neither was specified.

Parameters:

recommended - the recommended property

deprecated - the deprecated property

Returns:

the value of either the recommended, or the deprecated property. null if neither was specified and the default value of the new property is null.