Package org.anchoranalysis.mpp.feature.energy.scheme

Class EnergySchemeSet

Object

EnergySchemeSet

All Implemented Interfaces:

Iterable<SimpleNameValue<EnergyScheme>>

public class EnergySchemeSet
extends Object
implements Iterable<SimpleNameValue<EnergyScheme>>

A set of EnergySchemes, each associated with a unique name.

SharedFeatures are also associated with this set.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
EnergySchemeSet(SharedFeatures sharedFeatures)	Creates a new EnergySchemeSet instance.

Method Summary

Modifier and Type	Method	Description
boolean	add(String name, EnergyScheme energyScheme)	Adds a new EnergyScheme to the set with the given name.
SimpleNameValue<EnergyScheme>	get(String name)	Retrieves an EnergyScheme by its name.
SharedFeatures	getSharedFeatures()	Shared features associated with all energy schemes in the set.
Iterator<SimpleNameValue<EnergyScheme>>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

EnergySchemeSet

public EnergySchemeSet(SharedFeatures sharedFeatures)

Creates a new EnergySchemeSet instance.

Parameters:

sharedFeatures - Shared features associated with all energy schemes in the set.

Method Details

add

public boolean add(String name,
 EnergyScheme energyScheme)

Adds a new EnergyScheme to the set with the given name.

Parameters:

name - the unique name for the energy scheme

energyScheme - the EnergyScheme to add

Returns:

true if the energy scheme was successfully added

get

public SimpleNameValue<EnergyScheme> get(String name)

Retrieves an EnergyScheme by its name.

Parameters:

name - the name of the energy scheme to retrieve

Returns:

the SimpleNameValue containing the named EnergyScheme, or null if not found

iterator

public Iterator<SimpleNameValue<EnergyScheme>> iterator()

Specified by:

iterator in interface Iterable<SimpleNameValue<EnergyScheme>>

getSharedFeatures

public SharedFeatures getSharedFeatures()

Shared features associated with all energy schemes in the set.