org.apache.giraph.conf

Class StrConfOption

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

org.apache.giraph.conf.StrConfOption

All Implemented Interfaces:

Comparable<AbstractConfOption>

public class StrConfOption
extends AbstractConfOption

String Configuration option

Constructor Summary

Constructors

Constructor and Description
StrConfOption(String key, String defaultValue, String description) Constructor

Method Summary

Modifier and Type	Method and Description
String	get(org.apache.hadoop.conf.Configuration conf) Lookup value
String[]	getArray(org.apache.hadoop.conf.Configuration conf) Get array of values for key
String	getDefaultValue()
String	getDefaultValueStr() Get string representation of default value
List<String>	getList(org.apache.hadoop.conf.Configuration conf) Get list of values for key
ConfOptionType	getType() Get type this option holds
String	getWithDefault(org.apache.hadoop.conf.Configuration conf, String defaultVal) Lookup value with user defined defaultValue
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, String value) Set value for key
void	setIfUnset(org.apache.hadoop.conf.Configuration conf, String value) Set value if 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

StrConfOption

public StrConfOption(String key,
                     String defaultValue,
                     String description)

Constructor

Parameters:

key - key

defaultValue - default value

description - configuration description

Method Detail

getDefaultValue

public String getDefaultValue()

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 String get(org.apache.hadoop.conf.Configuration conf)

Lookup value

Parameters:

conf - Configuration

Returns:

value for key, or defaultValue

getWithDefault

public String getWithDefault(org.apache.hadoop.conf.Configuration conf,
                             String defaultVal)

Lookup value with user defined defaultValue

Parameters:

conf - Configuration

defaultVal - default value to use

Returns:

value for key, or defaultVal passed in

getArray

public String[] getArray(org.apache.hadoop.conf.Configuration conf)

Get array of values for key

Parameters:

conf - Configuration

Returns:

array of values for key

getList

public List<String> getList(org.apache.hadoop.conf.Configuration conf)

Get list of values for key

Parameters:

conf - Configuration

Returns:

list of values for key

set

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

Set value for key

Parameters:

conf - Configuration

value - to set

setIfUnset

public void setIfUnset(org.apache.hadoop.conf.Configuration conf,
                       String value)

Set value if not already present

Parameters:

conf - Configuration

value - to set