Package org.cyclos.model

Class Submodules

java.lang.Object

org.cyclos.model.Submodules

public class Submodules
extends Object

Contains helper methods to handle Submodules

Constructor Summary

Constructors

Constructor	Description
Submodules()

Method Summary

Modifier and Type	Method	Description
static Submodule	aggregate(Set<Submodule> submodules)	Returns an instance aggregating all the given submodules
static Submodule	aggregate(Submodule... submodules)	Returns an instance aggregating all the given submodules
static Set<Submodule>	flatten(Submodule submodule)	Flattens the given submodule, returning all submodules if it is an instance of Submodules or the parameter in a singleton
static Submodule	from(String str)	Returns the submodule for the given string, in the format [module.submodule].
static Submodule	fromKey(String key)	Returns the submodule for the given string, in the format [module.submodule.key].
static int	getId(Submodule submodule)	Returns an identifier for a given submodule
static Map<String,Class<? extends PrefixedEnum>>	getPrefixMapping()	Returns the prefix mapping (submodules are PrefixedEnum)
static Class<? extends Submodule>	getSubmoduleClassFor(Module module)	Returns the submodule enum class for the given module
static List<? extends Submodule>	getSubmodulesFromModule(Module module)
static String	qualifiedName(Submodule submodule)	Returns the qualified name for the given submodule, that is: <MODULE>.<SUBMODULE>

Methods inherited from class java.lang.Object

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

Constructor Detail

Submodules

public Submodules()

Method Detail

aggregate

public static Submodule aggregate(Set<Submodule> submodules)

Returns an instance aggregating all the given submodules

aggregate

public static Submodule aggregate(Submodule... submodules)

Returns an instance aggregating all the given submodules

flatten

public static Set<Submodule> flatten(Submodule submodule)

Flattens the given submodule, returning all submodules if it is an instance of Submodules or the parameter in a singleton

from

public static Submodule from(String str)

Returns the submodule for the given string, in the format [module.submodule].

fromKey

public static Submodule fromKey(String key)

Returns the submodule for the given string, in the format [module.submodule.key].

getId

public static int getId(Submodule submodule)

Returns an identifier for a given submodule

getPrefixMapping

public static Map<String,Class<? extends PrefixedEnum>> getPrefixMapping()

Returns the prefix mapping (submodules are PrefixedEnum)

getSubmoduleClassFor

public static Class<? extends Submodule> getSubmoduleClassFor(Module module)

Returns the submodule enum class for the given module

getSubmodulesFromModule

public static List<? extends Submodule> getSubmodulesFromModule(Module module)

qualifiedName

public static String qualifiedName(Submodule submodule)

Returns the qualified name for the given submodule, that is: <MODULE>.<SUBMODULE>