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:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Class<?>	getAnnotatedClass() This method gets the Class that was annotated with the mode.
Set<? extends CliModeObject>	getExtendedModes() This method gets the Set of modes that are extended by this mode including this mode itself.
String	getId() The ID of the mode.
CliMode	getMode() This method gets the actual CliMode.
String	getTitle() The title of the mode.

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.

getExtendedModes

Set<? extends CliModeObject> getExtendedModes()

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

Returns:

the extended modes including this mode itself.