net.sf.mmm.util.cli.api

Class CliOptionAndArgumentAnnotationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.mmm.util.exception.api.NlsRuntimeException

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

net.sf.mmm.util.cli.api.CliOptionAndArgumentAnnotationException

All Implemented Interfaces:

Serializable, Cloneable, NlsThrowable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, NlsObject

public class CliOptionAndArgumentAnnotationException
extends CliException

A CliOptionAndArgumentAnnotationException is thrown if a property is annotated with both CliOption and CliArgument.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_CODE
private static long	serialVersionUID

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

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, 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_USER, KEY_VALUE

Constructor Summary

Constructors

Constructor and Description
CliOptionAndArgumentAnnotationException(String property) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getCode() This method gets the code that identifies the detailed type of this object.
boolean	isTechnical() Determines if this is a technical exception.

Methods inherited from class net.sf.mmm.util.cli.api.CliException

createBundle

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

createBundle, createCopy, createCopyViaClone, createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, isForUser, printStackTrace, toNlsMessage, toString, toString, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

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.exception.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

getCode(), Constant Field Values

Constructor Detail

CliOptionAndArgumentAnnotationException

public CliOptionAndArgumentAnnotationException(String property)

The constructor.

Parameters:

property - is the according property.

Method Detail

getCode

public String getCode()

Description copied from interface: AttributeReadMessageCode

This method gets the code that identifies the detailed type of this object. While UUID or ID are typically unique per instance of an object the code is unique for all instances of the exact same kind. So e.g. a particular kind of exception or ValidationFailure can be identified by its code. A simple generic implementation may return the classname or the key of the NLS message. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned as String literal). This code may be used as a compact identifier to reference the related problem or information as well as for automatic tests of error situations that should remain stable even if the message text gets improved or the locale is unknown.

Specified by:

getCode in interface AttributeReadMessageCode

Overrides:

getCode in class NlsRuntimeException

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message

isTechnical

public boolean isTechnical()

Description copied from interface: NlsThrowable

Determines if this is a technical exception.

• A technical exception is an unexpected situation that is to be logged on error level and should be analyzed by the operators or software developers of the system. Further in such case the end-user can typically do nothing about the problem (except to retry his operation) and will typically not understand the problem. Therefore a generic message should be displayed to the end-user in such case. See TechnicalErrorUserException.
• A non technical exception is called user failure. It is an undesired but NOT abnormal situation. It should be logged on a level less than error (typically info). The message is typically intended for to end-users and has to be easy to understand.

This separation is intentionally not done via inheritance of technical and business exception base classes to allow reuse. However, if you want to have it this way, create such classes derived from NlsRuntimeException.

Specified by:

isTechnical in interface NlsThrowable

Overrides:

isTechnical in class CliException

Returns:

true if this is a technical exception, false if this is a user error.

See Also:

NlsThrowable.isForUser()