net.sf.mmm.util.lang.api.attribute

Interface AttributeReadMessageCode

All Known Subinterfaces:

Message, NlsThrowable, ValidationFailure

All Known Implementing Classes:

AbstractErrorMessage, AbstractMessage, AbstractValidationFailure, AccessFailedException, AlreadyInitializedException, AnnotationNotForTargetException, AnnotationNotRuntimeException, BufferExceedException, BusinessErrorUserException, CliArgumentMissingException, CliArgumentReferenceMissingException, CliClassNoPropertyException, CliException, CliModeUndefinedException, CliOptionAndArgumentAnnotationException, CliOptionDuplicateException, CliOptionIllegalNameOrAliasException, CliOptionIncompatibleModesException, CliOptionMisplacedException, CliOptionMissingException, CliOptionMissingValueException, CliOptionUndefinedException, CliParameterListEmptyException, CliParserExcepiton, ComposedException, ComposedValidationFailure, ContainerGrowthException, DuplicateObjectException, DuplicateObjectUserException, ErrorMessage, FileAlreadyExistsException, FileAttributeModificationFailedException, FileCreationFailedException, FileDeletionFailedException, FileNotExistsException, GenericSerializableException, IllegalCaseException, IllegalDateFormatException, IllegalPojoPathException, IllegalWildcardSequenceException, InformationMessage, InstantiationFailedException, InvocationFailedException, NlsClassCastException, NlsException, NlsFormatterChoiceNoElseConditionException, NlsFormatterChoiceOnlyElseConditionException, NlsIllegalArgumentException, NlsIllegalStateException, 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, RuntimeIoException, SearchAddFailedException, SearchEntryIdImmutableException, SearchException, SearchQueryParseException, SearchRemoveFailedException, SearchTimeoutException, SearchUpdateMissingIdException, SecurityErrorUserException, StreamClosedException, TechnicalErrorUserException, TransactionCommitException, TransactionNotActiveException, TransactionRollbackException, TypeNotFoundException, UnknownCollectionInterfaceException, ValidationErrorUserException, ValidationErrorUserException, ValidationFailureImpl, ValidationFailureSuccess, ValueConvertException, ValueConvertException, ValueException, ValueException, ValueNotSetException, ValueNotSetException, ValueOutOfRangeException, ValueOutOfRangeException, WarningMessage, WrongValueTypeException, WrongValueTypeException, XmlException, XmlGenericException, XmlInvalidException, XmlParseException

public interface AttributeReadMessageCode

This interface gives read access to the code of an object.

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
String	getCode() This method gets the code that identifies the detailed type of this object.

Method Detail

getCode

String getCode()

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.

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message