NlsObject (JavaDocs for mmm-all dev-SNAPSHOT)

All Known Subinterfaces:

NlsMessage, NlsThrowable

All Known Implementing Classes:

AbstractNlsMessage, AccessFailedException, AlreadyInitializedException, AnnotationNotForTargetException, AnnotationNotRuntimeException, BasicNlsMessage, BufferExceedException, BusinessErrorUserException, CliArgumentMissingException, CliArgumentReferenceMissingException, CliClassNoPropertyException, CliException, CliModeUndefinedException, CliOptionAndArgumentAnnotationException, CliOptionDuplicateException, CliOptionIllegalNameOrAliasException, CliOptionIncompatibleModesException, CliOptionMisplacedException, CliOptionMissingException, CliOptionMissingValueException, CliOptionUndefinedException, CliParameterListEmptyException, CliParserExcepiton, CompareOperator, ComposedException, ComposedNlsMessage, ContainerGrowthException, Direction, DuplicateObjectException, DuplicateObjectUserException, FileAlreadyExistsException, FileAttributeModificationFailedException, FileCreationFailedException, FileDeletionFailedException, FileNotExistsException, GenericSerializableException, IllegalCaseException, IllegalDateFormatException, IllegalPojoPathException, IllegalWildcardSequenceException, InstantiationFailedException, InvocationFailedException, NlsClassCastException, NlsException, NlsFormatterChoiceNoElseConditionException, NlsFormatterChoiceOnlyElseConditionException, NlsIllegalArgumentException, NlsIllegalStateException, NlsMessageImpl, NlsMessagePlain, NlsNullPointerException, NlsParseException, NlsRuntimeException, NlsRuntimeWrapperException, NlsUnsupportedOperationException, NodeCycleException, NotInitializedException, NumberConversionException, ObjectDisposedException, ObjectMismatchException, ObjectNotFoundException, ObjectNotFoundUserException, OptimisticLockingException, OptimisticLockingExceptionHibernate, OptimisticLockingExceptionJpa, OptimisticLockingExceptionSpring, PojoPathAccessException, PojoPathCachingDisabledException, PojoPathConversionException, PojoPathCreationException, PojoPathException, PojoPathSegmentIsNullException, PojoPathUnsafeException, PojoPropertyNotFoundException, ReadOnlyException, ReflectionException, RemoteInvocationCallFailedException, ResourceAmbiguousException, ResourceMissingException, ResourceNotAvailableException, ResourceNotWritableException, ResourceUriUndefinedException, RichTextFeature, RuntimeIoException, SearchAddFailedException, SearchEntryIdImmutableException, SearchException, SearchQueryParseException, SearchRemoveFailedException, SearchTimeoutException, SearchUpdateMissingIdException, SecurityErrorUserException, StreamClosedException, TechnicalErrorUserException, TransactionCommitException, TransactionNotActiveException, TransactionRollbackException, TypeNotFoundException, UnknownCollectionInterfaceException, ValidationErrorUserException, ValidationErrorUserException, ValueConvertException, ValueConvertException, ValueException, ValueException, ValueNotSetException, ValueNotSetException, ValueOutOfRangeException, ValueOutOfRangeException, WrongValueTypeException, WrongValueTypeException, XmlException, XmlGenericException, XmlInvalidException, XmlParseException
```
public interface NlsObject
```
This is the interface for an object with native language support. Such object be can converted to an i18n-message describing the object analog to its string representation.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ANNOTATION` Key for the `argument` "annotation".
`static String`	`KEY_ARGUMENT` Key for the `argument` "argument".
`static String`	`KEY_CAPACITY` Key for the `argument` "capacity".
`static String`	`KEY_CONTAINER` Key for the `argument` "container".
`static String`	`KEY_DEFAULT` Key for the `argument` "default".
`static String`	`KEY_DIRECTORY` Key for the `argument` "directory".
`static String`	`KEY_ERROR` Key for the `argument` "error".
`static String`	`KEY_EXISTING` Key for the `argument` "existing".
`static String`	`KEY_EXPECTED` Key for the `argument` "expected".
`static String`	`KEY_FILE` Key for the `argument` "file".
`static String`	`KEY_FUNCTION` Key for the `argument` "function".
`static String`	`KEY_ID` Key for the `argument` "id".
`static String`	`KEY_KEY` Key for the `argument` "key".
`static String`	`KEY_LOCATION` Key for the `argument` "location".
`static String`	`KEY_MAX` Key for the `argument` "max".
`static String`	`KEY_MIN` Key for the `argument` "min".
`static String`	`KEY_MODE` Key for the `argument` "mode".
`static String`	`KEY_NAME` Key for the `argument` "name".
`static String`	`KEY_OBJECT` Key for the `argument` "object".
`static String`	`KEY_OPERAND` Key for the `argument` "operand".
`static String`	`KEY_OPERATION` Key for the `argument` "operation".
`static String`	`KEY_OPTION` Key for the `argument` "option".
`static String`	`KEY_PATH` Key for the `argument` "path".
`static String`	`KEY_PROPERTY` Key for the `argument` "property".
`static String`	`KEY_QUERY` Key for the `argument` "query".
`static String`	`KEY_RESOURCE` Key for the `argument` "resource".
`static String`	`KEY_SIZE` Key for the `argument` "size".
`static String`	`KEY_SOURCE` Key for the `argument` "source".
`static String`	`KEY_TARGET_TYPE` Key for the `argument` "targetType".
`static String`	`KEY_TITLE` Key for the `argument` "title".
`static String`	`KEY_TYPE` Key for the `argument` "type".
`static String`	`KEY_URI` Key for the `argument` "uri".
`static String`	`KEY_USER` Key for the `argument` "user".
`static String`	`KEY_VALUE` Key for the `argument` "value".

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NlsMessage`	`toNlsMessage()` This method is the equivalent to `Object.toString()` with native language support.

- Field Detail
  - KEY_OBJECT
```
static final String KEY_OBJECT
```
    Key for the argument "object".
    
    See Also:
    
    Constant Field Values
  - KEY_KEY
```
static final String KEY_KEY
```
    Key for the argument "key".
    
    See Also:
    
    Constant Field Values
  - KEY_ID
```
static final String KEY_ID
```
    Key for the argument "id".
    
    See Also:
    
    Constant Field Values
  - KEY_VALUE
```
static final String KEY_VALUE
```
    Key for the argument "value".
    
    See Also:
    
    Constant Field Values
  - KEY_TYPE
```
static final String KEY_TYPE
```
    Key for the argument "type".
    
    See Also:
    
    Constant Field Values
  - KEY_SOURCE
```
static final String KEY_SOURCE
```
    Key for the argument "source".
    
    See Also:
    
    Constant Field Values
  - KEY_MIN
```
static final String KEY_MIN
```
    Key for the argument "min".
    
    See Also:
    
    Constant Field Values
  - KEY_MAX
```
static final String KEY_MAX
```
    Key for the argument "max".
    
    See Also:
    
    Constant Field Values
  - KEY_RESOURCE
```
static final String KEY_RESOURCE
```
    Key for the argument "resource".
    
    See Also:
    
    Constant Field Values
  - KEY_SIZE
```
static final String KEY_SIZE
```
    Key for the argument "size".
    
    See Also:
    
    Constant Field Values
  - KEY_CAPACITY
```
static final String KEY_CAPACITY
```
    Key for the argument "capacity".
    
    See Also:
    
    Constant Field Values
  - KEY_PROPERTY
```
static final String KEY_PROPERTY
```
    Key for the argument "property".
    
    See Also:
    
    Constant Field Values
  - KEY_PATH
```
static final String KEY_PATH
```
    Key for the argument "path".
    
    See Also:
    
    Constant Field Values
  - KEY_NAME
```
static final String KEY_NAME
```
    Key for the argument "name".
    
    See Also:
    
    Constant Field Values
  - KEY_OPTION
```
static final String KEY_OPTION
```
    Key for the argument "option".
    
    See Also:
    
    Constant Field Values
  - KEY_MODE
```
static final String KEY_MODE
```
    Key for the argument "mode".
    
    See Also:
    
    Constant Field Values
  - KEY_FILE
```
static final String KEY_FILE
```
    Key for the argument "file".
    
    See Also:
    
    Constant Field Values
  - KEY_DIRECTORY
```
static final String KEY_DIRECTORY
```
    Key for the argument "directory".
    
    See Also:
    
    Constant Field Values
  - KEY_OPERAND
```
static final String KEY_OPERAND
```
    Key for the argument "operand".
    
    See Also:
    
    Constant Field Values
  - KEY_DEFAULT
```
static final String KEY_DEFAULT
```
    Key for the argument "default".
    
    See Also:
    
    Constant Field Values
  - KEY_ARGUMENT
```
static final String KEY_ARGUMENT
```
    Key for the argument "argument".
    
    See Also:
    
    Constant Field Values
  - KEY_FUNCTION
```
static final String KEY_FUNCTION
```
    Key for the argument "function".
    
    See Also:
    
    Constant Field Values
  - KEY_OPERATION
```
static final String KEY_OPERATION
```
    Key for the argument "operation".
    
    See Also:
    
    Constant Field Values
  - KEY_TARGET_TYPE
```
static final String KEY_TARGET_TYPE
```
    Key for the argument "targetType".
    
    See Also:
    
    Constant Field Values
  - KEY_ANNOTATION
```
static final String KEY_ANNOTATION
```
    Key for the argument "annotation".
    
    See Also:
    
    Constant Field Values
  - KEY_LOCATION
```
static final String KEY_LOCATION
```
    Key for the argument "location".
    
    See Also:
    
    Constant Field Values
  - KEY_QUERY
```
static final String KEY_QUERY
```
    Key for the argument "query".
    
    See Also:
    
    Constant Field Values
  - KEY_URI
```
static final String KEY_URI
```
    Key for the argument "uri".
    
    See Also:
    
    Constant Field Values
  - KEY_TITLE
```
static final String KEY_TITLE
```
    Key for the argument "title".
    
    See Also:
    
    Constant Field Values
  - KEY_ERROR
```
static final String KEY_ERROR
```
    Key for the argument "error".
    
    Since:
    
    2.0.1
    
    See Also:
    
    Constant Field Values
  - KEY_USER
```
static final String KEY_USER
```
    Key for the argument "user".
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_EXISTING
```
static final String KEY_EXISTING
```
    Key for the argument "existing".
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_EXPECTED
```
static final String KEY_EXPECTED
```
    Key for the argument "expected".
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
  - KEY_CONTAINER
```
static final String KEY_CONTAINER
```
    Key for the argument "container".
    
    Since:
    
    3.0.0
    
    See Also:
    
    Constant Field Values
- Method Detail
  - toNlsMessage
```
NlsMessage toNlsMessage()
```
    This method is the equivalent to Object.toString() with native language support.
    
    Returns:
    
    an nls message representing this object.

Interface NlsObject

Field Summary

Method Summary

Field Detail

KEY_OBJECT

KEY_KEY

KEY_ID

KEY_VALUE

KEY_TYPE

KEY_SOURCE

KEY_MIN

KEY_MAX

KEY_RESOURCE

KEY_SIZE

KEY_CAPACITY

KEY_PROPERTY

KEY_PATH

KEY_NAME

KEY_OPTION

KEY_MODE

KEY_FILE

KEY_DIRECTORY

KEY_OPERAND

KEY_DEFAULT

KEY_ARGUMENT

KEY_FUNCTION

KEY_OPERATION

KEY_TARGET_TYPE

KEY_ANNOTATION

KEY_LOCATION

KEY_QUERY

KEY_URI

KEY_TITLE

KEY_ERROR

KEY_USER

KEY_EXISTING

KEY_EXPECTED

KEY_CONTAINER

Method Detail

toNlsMessage