net.sf.mmm.util.cli.api

Interface CliModeObject

All Known Implementing Classes:

CliModeContainer

public interface 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)

Method Summary

Modifier and Type	Method and Description
Class<?>	getAnnotatedClass() This method gets the Class that was annotated with the mode.
String	getId() The ID of the mode.
CliMode	getMode() This method gets the actual CliMode.
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.

Method Detail

getId

String getId()

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

Returns:

the ID.

getTitle

String getTitle()

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 getMode() may return null.

Returns:

the title or the ID if title is NOT set.

getMode

CliMode getMode()

This method gets the actual CliMode.

Returns:

the CliMode or null if no CliMode annotation was present.

getAnnotatedClass

Class<?> getAnnotatedClass()

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

Returns:

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

isAncestorOf

boolean isAncestorOf(CliModeObject childMode)

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.

Parameters:

childMode - is the CliModeObject to relate to.

Returns:

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

isDescendantOf

boolean isDescendantOf(CliModeObject parentMode)

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.

Parameters:

parentMode - is the CliModeObject to relate to.

Returns:

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