org.apache.giraph.conf

Class AbstractConfOption

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

All Implemented Interfaces:

Comparable<AbstractConfOption>

Direct Known Subclasses:

BooleanConfOption, ClassConfOption, EnumConfOption, FloatConfOption, IntConfOption, JsonStringConfOption, LongConfOption, StrConfOption

public abstract class AbstractConfOption
extends Object
implements Comparable<AbstractConfOption>

Abstract base class of configuration options

Constructor Summary

Constructors

Constructor and Description
AbstractConfOption(String key, String description) Constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractConfOption o)
boolean	contains(org.apache.hadoop.conf.Configuration conf) Check if option is set in configuration
boolean	equals(Object o)
abstract String	getDefaultValueStr() Get string representation of default value
String	getDescription()
String	getKey()
abstract ConfOptionType	getType() Get type this option holds
int	hashCode()
abstract boolean	isDefaultValue(org.apache.hadoop.conf.Configuration conf) Check if the value set is the same as the default value
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfOption

public AbstractConfOption(String key,
                          String description)

Constructor

Parameters:

key - configuration key

description - configuration description

Method Detail

getKey

public String getKey()

getDescription

public String getDescription()

Returns:

the description

contains

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

Check if option is set in configuration

Parameters:

conf - Configuration

Returns:

true if option is set

compareTo

public int compareTo(AbstractConfOption o)

Specified by:

compareTo in interface Comparable<AbstractConfOption>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isDefaultValue

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

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

Parameters:

conf - Configuration

Returns:

true if value set is default value

getDefaultValueStr

public abstract String getDefaultValueStr()

Get string representation of default value

Returns:

String

getType

public abstract ConfOptionType getType()

Get type this option holds

Returns:

ConfOptionType