org.apache.giraph.conf

Class JsonStringConfOption

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

org.apache.giraph.conf.JsonStringConfOption

All Implemented Interfaces:

Comparable<AbstractConfOption>

public class JsonStringConfOption
extends AbstractConfOption

JSON String configuration option

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	get(org.apache.hadoop.conf.Configuration conf, Class<T> klass) Get JSON value
<T> T	get(org.apache.hadoop.conf.Configuration conf, org.codehaus.jackson.type.TypeReference<T> typeReference) Get JSON value
String	getDefaultValueStr() Get string representation of default value
String	getRaw(org.apache.hadoop.conf.Configuration conf) Get raw JSON string
ConfOptionType	getType() Get type this option holds
<T> T	getWithDefault(org.apache.hadoop.conf.Configuration conf, Class<T> klass, T defaultValue) Get JSON value, or default if not present
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, Object value) Set JSON value

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

JsonStringConfOption

public JsonStringConfOption(String key,
                            String description)

Constructor

Parameters:

key - String key name

description - String description of option

Method Detail

set

public void set(org.apache.hadoop.conf.Configuration conf,
                Object value)

Set JSON value

Parameters:

conf - Configuration

value - Json value

getRaw

public String getRaw(org.apache.hadoop.conf.Configuration conf)

Get raw JSON string

Parameters:

conf - Configuration

Returns:

raw JSON string value

get

public <T> T get(org.apache.hadoop.conf.Configuration conf,
                 Class<T> klass)

Get JSON value

Type Parameters:

T - JSON type

Parameters:

conf - Configuration

klass - Class to read into

Returns:

JSON value

get

public <T> T get(org.apache.hadoop.conf.Configuration conf,
                 org.codehaus.jackson.type.TypeReference<T> typeReference)

Get JSON value

Type Parameters:

T - JSON type

Parameters:

conf - Configuration

typeReference - TypeReference for JSON type

Returns:

JSON value

getWithDefault

public <T> T getWithDefault(org.apache.hadoop.conf.Configuration conf,
                            Class<T> klass,
                            T defaultValue)

Get JSON value, or default if not present

Type Parameters:

T - JSON type

Parameters:

klass - Class to read into

conf - Configuration

defaultValue - Default value if not found

Returns:

JSON value

getDefaultValueStr

public String getDefaultValueStr()

Description copied from class: AbstractConfOption

Get string representation of default value

Specified by:

getDefaultValueStr in class AbstractConfOption

Returns:

String

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

getType

public ConfOptionType getType()

Description copied from class: AbstractConfOption

Get type this option holds

Specified by:

getType in class AbstractConfOption

Returns:

ConfOptionType