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

Interface AttributeReadMessage

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 AttributeReadMessage

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

Since:

3.1.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
String	getMessage() This method gets the actual message that describes this object.

Method Detail

getMessage

String getMessage()

This method gets the actual message that describes this object. Such message should contain contextual information to describe and track down the information, problem, warning or error. It is either technical and should help operators or developers to identify what happened or it will be information displayed to end-users and should be clear and easy to understand. For internationalization see Message and NlsMessage. In any case it should NOT contain sensitive information such as passwords or (detailed) personal data.

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message