net.sf.mmm.util.cli.base

Class CliModeContainer

java.lang.Object

net.sf.mmm.util.cli.base.CliModeContainer

All Implemented Interfaces:

CliModeObject

public class CliModeContainer
extends Object
implements CliModeObject

This is a container for a CliMode together with additional associated information.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private Class<?>	annotatedClass
private Set<CliModeContainer>	extendedModes
private String	id
private CliMode	mode
private InitializationState	state

Constructor Summary

Constructors

Modifier	Constructor and Description
	CliModeContainer(CliMode mode, Class<?> annotatedClass) The constructor.
private	CliModeContainer(CliMode mode, Class<?> annotatedClass, String id) The constructor.
	CliModeContainer(String id) The constructor for a dummy instance.

Method Summary

Modifier and Type	Method and Description
Class<?>	getAnnotatedClass() This method gets the Class that was annotated with the mode.
Set<CliModeContainer>	getExtendedModes() This method gets the Set of modes that are extended by this mode.
String	getId() The ID of the mode.
CliMode	getMode() This method gets the actual CliMode.
InitializationState	getState()
String	getTitle() The title of the mode.
boolean	isAncestorOf(CliModeObject childMode) Determines if this CliModeObject is an ancestor of the given childMode.
boolean	isDescendantOf(CliModeObject parentMode) Determines if this CliModeObject is a descendant of the given parentMode.
void	setState(InitializationState state)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

id

private final String id

mode

private final CliMode mode

annotatedClass

private final Class<?> annotatedClass

extendedModes

private final Set<CliModeContainer> extendedModes

state

private InitializationState state

Constructor Detail

CliModeContainer

public CliModeContainer(String id)

The constructor for a dummy instance.

Parameters:

id - is the ID.

CliModeContainer

public CliModeContainer(CliMode mode,
                        Class<?> annotatedClass)

The constructor.

Parameters:

mode - is the mode.

annotatedClass - is the annotated class.

CliModeContainer

private CliModeContainer(CliMode mode,
                         Class<?> annotatedClass,
                         String id)

The constructor.

Parameters:

mode - is the mode.

annotatedClass - is the annotated class.

id - is the ID.

Method Detail

getId

public String getId()

Description copied from interface: CliModeObject

The ID of the mode.
ATTENTION:
Please use this method to get the ID as CliModeObject.getMode() may return null.

Specified by:

getId in interface CliModeObject

Returns:

the ID.

getTitle

public String getTitle()

Description copied from interface: CliModeObject

The title of the mode. If the title is NOT set, the ID is returned
ATTENTION:
Please use this method to get the title as CliModeObject.getMode() may return null.

Specified by:

getTitle in interface CliModeObject

Returns:

the title or the ID if title is NOT set.

getMode

public CliMode getMode()

Description copied from interface: CliModeObject

This method gets the actual CliMode.

Specified by:

getMode in interface CliModeObject

Returns:

the CliMode or null if no CliMode annotation was present.

getAnnotatedClass

public Class<?> getAnnotatedClass()

Description copied from interface: CliModeObject

This method gets the Class that was annotated with the mode.

Specified by:

getAnnotatedClass in interface CliModeObject

Returns:

the annotated Class or null if CliModeObject.getMode() is null.

getExtendedModes

public Set<CliModeContainer> getExtendedModes()

This method gets the Set of modes that are extended by this mode.

Returns:

the extended modes including this mode itself.

isAncestorOf

public boolean isAncestorOf(CliModeObject childMode)

Description copied from interface: CliModeObject

Determines if this CliModeObject is an ancestor of the given childMode. So if the given childMode extends this CliModeObject directly or indirect, this method will return true.

Specified by:

isAncestorOf in interface CliModeObject

Parameters:

childMode - is the CliModeObject to relate to.

Returns:

true this CliModeObject is an ancestor of the given childMode, false otherwise.

isDescendantOf

public boolean isDescendantOf(CliModeObject parentMode)

Description copied from interface: CliModeObject

Determines if this CliModeObject is a descendant of the given parentMode. So if this CliModeObject extends the given childMode directly or indirect, this method will return true.

Specified by:

isDescendantOf in interface CliModeObject

Parameters:

parentMode - is the CliModeObject to relate to.

Returns:

true this CliModeObject is a descendant of the given parentMode , false otherwise.

getState

public InitializationState getState()

Returns:

the state

setState

public void setState(InitializationState state)

Parameters:

state - is the state to set

toString

public String toString()

Overrides:

toString in class Object