org.apache.giraph.conf

Class FloatConfOption

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

org.apache.giraph.conf.FloatConfOption

All Implemented Interfaces:

Comparable<AbstractConfOption>

public class FloatConfOption
extends AbstractConfOption

Float Configuration option

Constructor Summary

Constructors

Constructor and Description
FloatConfOption(String key, float defaultValue, String description) Constructor

Method Summary

Modifier and Type	Method and Description
float	get(org.apache.hadoop.conf.Configuration conf) Lookup value
float	getDefaultValue()
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, float value) Set value
void	setIfUnset(org.apache.hadoop.conf.Configuration conf, float 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

FloatConfOption

public FloatConfOption(String key,
                       float defaultValue,
                       String description)

Constructor

Parameters:

key - Configuration key

defaultValue - default value

description - configuration description

Method Detail

getDefaultValue

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

Lookup value

Parameters:

conf - Configuration

Returns:

value for key, or defaultValue if not present

set

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

Set value

Parameters:

conf - Configuration

value - to set

setIfUnset

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

Set value if it's not already present

Parameters:

conf - Configuration

value - to set