org.apache.giraph.conf

Class BooleanConfOption

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

org.apache.giraph.conf.BooleanConfOption

All Implemented Interfaces:

Comparable<AbstractConfOption>

public class BooleanConfOption
extends AbstractConfOption

Boolean configuration option

Constructor Summary

Constructors

Constructor and Description
BooleanConfOption(String key, boolean defaultValue, String description) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	get(org.apache.hadoop.conf.Configuration conf) Lookup value in Configuration
boolean	getDefaultValue() Get the default value of this option
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
boolean	isFalse(org.apache.hadoop.conf.Configuration conf) Check if value is true
boolean	isTrue(org.apache.hadoop.conf.Configuration conf) Check if value is false
void	set(org.apache.hadoop.conf.Configuration conf, boolean value) Set value in configuration for this key
void	setIfUnset(org.apache.hadoop.conf.Configuration conf, boolean value) Set value in configuration if it hasn't been set already

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

BooleanConfOption

public BooleanConfOption(String key,
                         boolean defaultValue,
                         String description)

Constructor

Parameters:

key - configuration key

defaultValue - default value

description - configuration description

Method Detail

getDefaultValue

public boolean getDefaultValue()

Get the default value of this option

Returns:

default value

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

Lookup value in Configuration

Parameters:

conf - Configuration

Returns:

value for key in conf, or defaultValue if not present

isFalse

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

Check if value is true

Parameters:

conf - Configuration

Returns:

true if value is set and true, false otherwise

isTrue

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

Check if value is false

Parameters:

conf - Configuration

Returns:

true if value is set and true, false otherwise

set

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

Set value in configuration for this key

Parameters:

conf - Configuration

value - to set

setIfUnset

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

Set value in configuration if it hasn't been set already

Parameters:

conf - Configuration

value - to set