ConfigurationImpl (REEF 0.10.0-incubating API)

java.lang.Object
- org.apache.reef.tang.implementation.ConfigurationImpl

All Implemented Interfaces:: Configuration

public class ConfigurationImpl
extends Object
implements Configuration

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`<T> ClassNode<ExternalConstructor<T>>`	`getBoundConstructor(ClassNode<T> cn)`
`Set<ClassNode<?>>`	`getBoundConstructors()`
`<T> ClassNode<T>`	`getBoundImplementation(ClassNode<T> cn)`
`Set<ClassNode<?>>`	`getBoundImplementations()`
`List<Object>`	`getBoundList(NamedParameterNode<List<?>> np)` Get the list bound to a given NamedParameterNode.
`Set<NamedParameterNode<List<?>>>`	`getBoundLists()`
`Set<Object>`	`getBoundSet(NamedParameterNode<Set<?>> np)` Obtain the set of class hierarchy nodes or strings that were bound to a given NamedParameterNode.
`Iterable<Map.Entry<NamedParameterNode<Set<?>>,Object>>`	`getBoundSets()` Get the set bindings from set-valued NamedParameters to the values they were bound to.
`ClassHierarchy`	`getClassHierarchy()` Configuration objects are associated with the ClassHierarchy objects that were used during validation.
`<T> ConstructorDef<T>`	`getLegacyConstructor(ClassNode<T> cn)` Return the LegacyConstructor that has been bound to this Class.
`Set<ClassNode<?>>`	`getLegacyConstructors()`
`String`	`getNamedParameter(NamedParameterNode<?> np)` Return the value of the given named parameter as an unparsed string.
`Set<NamedParameterNode<?>>`	`getNamedParameters()`
`int`	`hashCode()`
`ConfigurationBuilder`	`newBuilder()` Create a new ConfigurationBuilder object based on the same classpath as this Configuration, and populate it with the configuration options of this object.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getNamedParameter
```
public String getNamedParameter(NamedParameterNode<?> np)
```
    Description copied from interface: Configuration
    
    Return the value of the given named parameter as an unparsed string.
    If nothing was explicitly bound, this method returns null (it does not return default values).
    
    Specified by:
    
    getNamedParameter in interface Configuration
    
    Parameters:
    np - A NamedParameter object from this Configuration's class hierarchy.
    
    Returns:
    The validated string that this parameter is bound to, or null.
    See Also:
    Configuration.getClassHierarchy()
  - getBoundConstructor
```
public <T> ClassNode<ExternalConstructor<T>> getBoundConstructor(ClassNode<T> cn)
```
    Specified by:
    
    getBoundConstructor in interface Configuration
    
    Returns:
    the external constructor that cn has been explicitly bound to, or null. Defaults are not returned.
  - getBoundImplementations
```
public Set<ClassNode<?>> getBoundImplementations()
```
    Specified by:
    
    getBoundImplementations in interface Configuration
    
    Returns:
    the set of all interfaces (or super-classes) that have been explicitly bound to an implementation sub-class.
  - getBoundConstructors
```
public Set<ClassNode<?>> getBoundConstructors()
```
    Specified by:
    
    getBoundConstructors in interface Configuration
    
    Returns:
    the set of all the interfaces that have had an external constructor bound to them.
  - getNamedParameters
```
public Set<NamedParameterNode<?>> getNamedParameters()
```
    Specified by:
    
    getNamedParameters in interface Configuration
    
    Returns:
    the set of all the named parameters that have been explicitly bound to something.
  - getLegacyConstructors
```
public Set<ClassNode<?>> getLegacyConstructors()
```
    Specified by:
    
    getLegacyConstructors in interface Configuration
    
    Returns:
    the set of all interfaces that have a legacy constructor binding.
  - getBoundImplementation
```
public <T> ClassNode<T> getBoundImplementation(ClassNode<T> cn)
```
    Specified by:
    
    getBoundImplementation in interface Configuration
    
    Returns:
    the implementation that cn has been explicitly bound to, or null. Defaults are not returned.
  - getLegacyConstructor
```
public <T> ConstructorDef<T> getLegacyConstructor(ClassNode<T> cn)
```
    Description copied from interface: Configuration
    
    Return the LegacyConstructor that has been bound to this Class. Such constructors are defined in the class, but missing their @Inject annotation.
    For now, only one legacy constructor can be bound per class.
    TODO: Should this return Set> instead?
    
    Specified by:
    
    getLegacyConstructor in interface Configuration
  - newBuilder
```
public ConfigurationBuilder newBuilder()
```
    Description copied from interface: Configuration
    
    Create a new ConfigurationBuilder object based on the same classpath as this Configuration, and populate it with the configuration options of this object.
    This API is unstable and should be considered private. Use the methods in org.apache.reef.Tang instead.
    
    Specified by:
    
    newBuilder in interface Configuration
  - getClassHierarchy
```
public ClassHierarchy getClassHierarchy()
```
    Description copied from interface: Configuration
    
    Configuration objects are associated with the ClassHierarchy objects that were used during validation.
    
    Specified by:
    
    getClassHierarchy in interface Configuration
    
    Returns:
    the ClassHierarchy that backs this Configuration.
  - getBoundSet
```
public Set<Object> getBoundSet(NamedParameterNode<Set<?>> np)
```
    Description copied from interface: Configuration
    
    Obtain the set of class hierarchy nodes or strings that were bound to a given NamedParameterNode. If nothing was explicitly bound, the set will be empty (it will not reflect any default values).
    
    Specified by:
    
    getBoundSet in interface Configuration
    
    Parameters:
    np - A NamedParameterNode from this Configuration's class hierarchy.
    
    Returns:
    A set of ClassHierarchy Node objects or a set of strings, depending on whether the NamedParameterNode refers to an interface or configuration options, respectively.
    See Also:
    Configuration.getClassHierarchy()
  - getBoundList
```
public List<Object> getBoundList(NamedParameterNode<List<?>> np)
```
    Description copied from interface: Configuration
    
    Get the list bound to a given NamedParameterNode. The list will be empty if nothing was bound.
    
    Specified by:
    
    getBoundList in interface Configuration
    
    Parameters:
    np - Target NamedParameter
    
    Returns:
    A list bound to np
  - getBoundSets
```
public Iterable<Map.Entry<NamedParameterNode<Set<?>>,Object>> getBoundSets()
```
    Description copied from interface: Configuration
    
    Get the set bindings from set-valued NamedParameters to the values they were bound to.
    TODO: This API seems wonky. Why not return a Set>> instead, and let the caller invoke getBoundSet() above?
    
    Specified by:
    
    getBoundSets in interface Configuration
    
    Returns:
    a flattened set with one entry for each binding (the same NamedParameterNode may be a key for multiple bindings.
  - getBoundLists
```
public Set<NamedParameterNode<List<?>>> getBoundLists()
```
    Specified by:
    
    getBoundLists in interface Configuration
    
    Returns:
    the set of all NamedParameterNodes explicitly bound to lists.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ConfigurationImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getNamedParameter

getBoundConstructor

getBoundImplementations

getBoundConstructors

getNamedParameters

getLegacyConstructors

getBoundImplementation

getLegacyConstructor

newBuilder

getClassHierarchy

getBoundSet

getBoundList

getBoundSets

getBoundLists

equals

hashCode