org.apache.giraph.conf

Class ClassConfOption<C>

java.lang.Object

org.apache.giraph.conf.AbstractConfOption

org.apache.giraph.conf.ClassConfOption<C>

Type Parameters:

C - interface of class

All Implemented Interfaces:

Comparable<AbstractConfOption>

public class ClassConfOption<C>
extends AbstractConfOption

Class configuration option

Method Summary

Modifier and Type	Method and Description
void	add(org.apache.hadoop.conf.Configuration conf, Class<? extends C> klass) Add class to list for key
static <T> void	addToClasses(org.apache.hadoop.conf.Configuration conf, String name, Class<? extends T> klass, Class<T> xface) Add a class to a property that is a list of classes.
static <T> ClassConfOption<T>	create(String key, Class<? extends T> defaultClass, Class<T> interfaceClass, String description) Static create method
Class<? extends C>	get(org.apache.hadoop.conf.Configuration conf) Lookup value
Class<? extends C>[]	getArray(org.apache.hadoop.conf.Configuration conf) Lookup array of classes for key
static <T> Class<? extends T>[]	getClassesOfType(org.apache.hadoop.conf.Configuration conf, String name, Class<T> xface, Class<? extends T>... defaultValue) Get classes from a property that all implement a given interface.
Class<? extends C>	getDefaultClass()
String	getDefaultValueStr() Get string representation of default value
Class<C>	getInterfaceClass()
ConfOptionType	getType() Get type this option holds
Class<? extends C>	getWithDefault(org.apache.hadoop.conf.Configuration conf, Class<? extends C> defaultValue) Lookup with user specified default value
boolean	isDefaultValue(org.apache.hadoop.conf.Configuration conf) Check if the value set is the same as the default value
C	newInstance(org.apache.hadoop.conf.Configuration conf) Create a new instance
void	set(org.apache.hadoop.conf.Configuration conf, Class<? extends C> klass) Set value for key
void	setIfUnset(org.apache.hadoop.conf.Configuration conf, Class<? extends C> klass) Set value for key if it is not already set
void	setMany(org.apache.hadoop.conf.Configuration conf, Class<? extends C>... klasses) Set classes for this key
String	toString()

Methods inherited from class org.apache.giraph.conf.AbstractConfOption

compareTo, contains, equals, getDescription, getKey, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <T> ClassConfOption<T> create(String key,
                                            Class<? extends T> defaultClass,
                                            Class<T> interfaceClass,
                                            String description)

Static create method

Type Parameters:

T - type of class

Parameters:

key - key

defaultClass - default class

interfaceClass - interface class

description - configuration description

Returns:

ClassConfOption

getDefaultClass

public Class<? extends C> getDefaultClass()

getInterfaceClass

public Class<C> getInterfaceClass()

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

toString

public String toString()

Overrides:

toString in class AbstractConfOption

newInstance

public C newInstance(org.apache.hadoop.conf.Configuration conf)

Create a new instance

Parameters:

conf - Configuration

Returns:

new instance of class held by this key

get

public Class<? extends C> get(org.apache.hadoop.conf.Configuration conf)

Lookup value

Parameters:

conf - Configuration

Returns:

Class set for key, or defaultClass

getArray

public Class<? extends C>[] getArray(org.apache.hadoop.conf.Configuration conf)

Lookup array of classes for key

Parameters:

conf - Configuration

Returns:

array of classes

getClassesOfType

public static <T> Class<? extends T>[] getClassesOfType(org.apache.hadoop.conf.Configuration conf,
                                                        String name,
                                                        Class<T> xface,
                                                        Class<? extends T>... defaultValue)

Get classes from a property that all implement a given interface.

Type Parameters:

T - Generic type of interface class

Parameters:

conf - Configuration

name - String name of property to fetch.

xface - interface classes must implement.

defaultValue - If not found, return this

Returns:

array of Classes implementing interface specified.

getWithDefault

public Class<? extends C> getWithDefault(org.apache.hadoop.conf.Configuration conf,
                                         Class<? extends C> defaultValue)

Lookup with user specified default value

Parameters:

conf - Configuration

defaultValue - default value

Returns:

Class

set

public void set(org.apache.hadoop.conf.Configuration conf,
                Class<? extends C> klass)

Set value for key

Parameters:

conf - Configuration

klass - Class to set

setIfUnset

public void setIfUnset(org.apache.hadoop.conf.Configuration conf,
                       Class<? extends C> klass)

Set value for key if it is not already set

Parameters:

conf - Configuration

klass - Class to set

setMany

public void setMany(org.apache.hadoop.conf.Configuration conf,
                    Class<? extends C>... klasses)

Set classes for this key

Parameters:

conf - Configuration

klasses - Classes to set

add

public void add(org.apache.hadoop.conf.Configuration conf,
                Class<? extends C> klass)

Add class to list for key

Parameters:

conf - Configuration

klass - Class to add

addToClasses

public static <T> void addToClasses(org.apache.hadoop.conf.Configuration conf,
                                    String name,
                                    Class<? extends T> klass,
                                    Class<T> xface)

Add a class to a property that is a list of classes. If the property does not exist it will be created.

Type Parameters:

T - type of class

Parameters:

conf - Configuration

name - String name of property.

klass - interface of the class being set.

xface - Class to add to the list.