Package org.goplanit.utils.mode

Interface Modes

All Superinterfaces:

Cloneable, Iterable<Mode>, LongMapWrapper<Mode>, ManagedIdEntities<Mode>, MapWrapper<Long,Mode>

All Known Implementing Classes:

ModesImpl

public interface Modes
extends ManagedIdEntities<Mode>

container class and factory methods for modes with some

Author:

markr

Method Summary

Modifier and Type	Method	Description
Modes	clone()	clone modes container
boolean	containsPredefinedMode(PredefinedModeType modeType)	verify if predefined mode is registered
PredefinedMode	get(PredefinedModeType modeType)	get predefined mode if it is registered
Mode	getByXmlId(String xmlId)	Retrieve a Mode by its XML Id
ModeFactory	getFactory()	Collect the mode factory to use for creating instances

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.goplanit.utils.wrapper.LongMapWrapper

get, remove

Methods inherited from interface org.goplanit.utils.id.ManagedIdEntities

containsKey, getManagedIdClass, recreateIds, recreateIds, reset

Methods inherited from interface org.goplanit.utils.wrapper.MapWrapper

addAll, clear, contains, findFirst, forEachIn, get, getFirst, getKeyByValue, isEmpty, register, remove, size, toCollection, valuesAsNewSet

Method Detail

get

PredefinedMode get(PredefinedModeType modeType)

get predefined mode if it is registered

Parameters:

modeType - to collect

Returns:

predefined mode when available, null otherwise

containsPredefinedMode

boolean containsPredefinedMode(PredefinedModeType modeType)

verify if predefined mode is registered

Parameters:

modeType - to verify

Returns:

true when available, false otherwise

getByXmlId

Mode getByXmlId(String xmlId)

Retrieve a Mode by its XML Id

Parameters:

xmlId - the XML Id of the specified mode

Returns:

the retrieved mode, or null if no mode was found

clone

Modes clone()

clone modes container

Specified by:

clone in interface ManagedIdEntities<Mode>

Specified by:

clone in interface MapWrapper<Long,Mode>

Returns:

clone of entities

getFactory

ModeFactory getFactory()

Collect the mode factory to use for creating instances

Specified by:

getFactory in interface ManagedIdEntities<Mode>

Returns:

modeFactory to create modes for this container