net.sf.mmm.util.cli.api
Class CliException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              net.sf.mmm.util.nls.api.AbstractNlsRuntimeException
                  net.sf.mmm.util.nls.api.NlsRuntimeException
                      net.sf.mmm.util.cli.api.CliException

All Implemented Interfaces:

Serializable, NlsObject, NlsThrowable

Direct Known Subclasses:

CliArgumentMissingException, CliArgumentReferenceMissingException, CliClassNoPropertyException, CliModeUndefinedException, CliOptionAndArgumentAnnotationException, CliOptionDuplicateException, CliOptionIllegalNameOrAliasException, CliOptionIncompatibleModesException, CliOptionMisplacedException, CliOptionMissingException, CliOptionMissingValueException, CliOptionUndefinedException, CliParameterListEmptyException, CliParserExcepiton

public abstract class CliException
extends NlsRuntimeException

A CliException is thrown, if the commandline arguments are invalid for a specific main-program.

Since:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID UID for serialization.

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_VALUE

Constructor Summary

CliException(String internationalizedMessage)
The constructor.

CliException(String internationalizedMessage, Map<String,Object> arguments)
The constructor.

CliException(Throwable nested, String internationalizedMessage)
The constructor.

CliException(Throwable nested, String internationalizedMessage, Map<String,Object> arguments)
The constructor.

Method Summary

Methods inherited from class net.sf.mmm.util.nls.api.NlsRuntimeException

addToMap, toMap, toMap, toMap

Methods inherited from class net.sf.mmm.util.nls.api.AbstractNlsRuntimeException

createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, printStackTrace, printStackTrace, printStackTrace, printStackTrace, toNlsMessage

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.nls.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

Constructor Detail

CliException

public CliException(String internationalizedMessage)

The constructor.

Parameters:

internationalizedMessage - is a short description of the problem. It is used for internationalization and should be in English language.

CliException

public CliException(Throwable nested,
                    String internationalizedMessage)

The constructor.

Parameters:

nested - is the cause of this exception.

internationalizedMessage - is a short description of the problem. It is used for internationalization and should be in English language.

CliException

public CliException(String internationalizedMessage,
                    Map<String,Object> arguments)

The constructor.

Parameters:

internationalizedMessage - is a short description of the problem. It is used for internationalization and should be in English language.

arguments - are the arguments to be filled into internationalizedMessage.

CliException

public CliException(Throwable nested,
                    String internationalizedMessage,
                    Map<String,Object> arguments)

The constructor.

Parameters:

nested - is the cause of this exception.

internationalizedMessage - is a short description of the problem. It is used for internationalization and should be in English language.

arguments - are the arguments to be filled into internationalizedMessage.