org.apache.giraph.conf

Class EnumConfOption<T extends Enum<T>>

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

org.apache.giraph.conf.EnumConfOption<T>

Type Parameters:

T - Enum class

All Implemented Interfaces:

Comparable<AbstractConfOption>

public class EnumConfOption<T extends Enum<T>>
extends AbstractConfOption

Enum Configuration option

Constructor Summary

Constructors

Constructor and Description
EnumConfOption(String key, Class<T> klass, T defaultValue, String description) Constructor

Method Summary

Modifier and Type	Method and Description
static <X extends Enum<X>> EnumConfOption<X>	create(String key, Class<X> klass, X defaultValue, String description) Create new EnumConfOption
T	get(org.apache.hadoop.conf.Configuration conf) Lookup value
String	getDefaultValueStr() Get string representation of default value
ConfOptionType	getType() Get type this option holds
boolean	isDefaultValue(org.apache.hadoop.conf.Configuration conf) Check if the value set is the same as the default value
void	set(org.apache.hadoop.conf.Configuration conf, Enum<T> value) Set value
void	setIfUnset(org.apache.hadoop.conf.Configuration conf, Enum<T> value) Set value if it's not already present

Methods inherited from class org.apache.giraph.conf.AbstractConfOption

compareTo, contains, equals, getDescription, getKey, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnumConfOption

public EnumConfOption(String key,
                      Class<T> klass,
                      T defaultValue,
                      String description)

Constructor

Parameters:

key - Configuration key

klass - Enum class

defaultValue - default value

description - description of the option

Method Detail

create

public static <X extends Enum<X>> EnumConfOption<X> create(String key,
                                                           Class<X> klass,
                                                           X defaultValue,
                                                           String description)

Create new EnumConfOption

Type Parameters:

X - enum type

Parameters:

key - String configuration key

klass - enum class

defaultValue - default enum value

description - description of the option

Returns:

EnumConfOption

isDefaultValue

public boolean isDefaultValue(org.apache.hadoop.conf.Configuration conf)

Description copied from class: AbstractConfOption

Check if the value set is the same as the default value

Specified by:

isDefaultValue in class AbstractConfOption

Parameters:

conf - Configuration

Returns:

true if value set is default value

getDefaultValueStr

public String getDefaultValueStr()

Description copied from class: AbstractConfOption

Get string representation of default value

Specified by:

getDefaultValueStr in class AbstractConfOption

Returns:

String

getType

public ConfOptionType getType()

Description copied from class: AbstractConfOption

Get type this option holds

Specified by:

getType in class AbstractConfOption

Returns:

ConfOptionType

get

public T get(org.apache.hadoop.conf.Configuration conf)

Lookup value

Parameters:

conf - Configuration

Returns:

enum value

set

public void set(org.apache.hadoop.conf.Configuration conf,
                Enum<T> value)

Set value

Parameters:

conf - Configuration

value - to set

setIfUnset

public void setIfUnset(org.apache.hadoop.conf.Configuration conf,
                       Enum<T> value)

Set value if it's not already present

Parameters:

conf - Configuration

value - to set