org.apache.giraph.conf

Class LongConfOption

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

org.apache.giraph.conf.LongConfOption

All Implemented Interfaces:

Comparable<AbstractConfOption>

public class LongConfOption
extends AbstractConfOption

Long configuration option

Constructor Summary

Constructors

Constructor and Description
LongConfOption(String key, long defaultValue, String description) Constructor

Method Summary

Modifier and Type	Method and Description
long	get(org.apache.hadoop.conf.Configuration conf) Lookup value
long	getDefaultValue()
String	getDefaultValueStr() Get string representation of default value
ConfOptionType	getType() Get type this option holds
long	getWithDefault(org.apache.hadoop.conf.Configuration conf, long val) Lookup value, use passed in default value if not found.
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, long value) Set value for key
void	setIfUnset(org.apache.hadoop.conf.Configuration conf, long 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

LongConfOption

public LongConfOption(String key,
                      long defaultValue,
                      String description)

Constructor

Parameters:

key - key

defaultValue - default value

description - configuration description

Method Detail

getDefaultValue

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

Lookup value

Parameters:

conf - Configuration

Returns:

value set for key, or defaultValue

getWithDefault

public long getWithDefault(org.apache.hadoop.conf.Configuration conf,
                           long val)

Lookup value, use passed in default value if not found.

Parameters:

conf - Configuration

val - default value to use

Returns:

set for key, or default value passed in

set

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

Set value for key

Parameters:

conf - Configuration

value - to set

setIfUnset

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

Set value if it's not already present

Parameters:

conf - Configuration

value - to set