- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- io.github.mmm.base.exception.ApplicationException
-
- io.github.mmm.base.exception.ReadOnlyException
-
- All Implemented Interfaces:
Localizable
,LocalizableObject
,Serializable
public class ReadOnlyException extends ApplicationException
AReadOnlyException
is thrown if the modification of something failed because it is read-only. Here something can be the property of a java object, an attribute in a persistent store, a file, etc.
ATTENTION:
Please design your APIs in a way to prevent such exception where ever possible. However for generic access to objects that can be mutable or read-only this exception is the right choice.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
MESSAGE_CODE
-
Constructor Summary
Constructors Constructor Description ReadOnlyException(Object object)
The constructor.ReadOnlyException(Object object, Object attribute)
The constructor.ReadOnlyException(Throwable cause, Object object)
The constructor.ReadOnlyException(Throwable cause, Object object, Object attribute)
The constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCode()
This method gets the code that identifies the detailed type of this object.-
Methods inherited from class io.github.mmm.base.exception.ApplicationException
createUuid, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getNlsMessage, getUuid, isForUser, isTechnical, printStackTrace, toString, toString, toString
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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 io.github.mmm.base.i18n.Localizable
getArgument, getLocalizedMessage, toLocalizable
-
-
-
-
Field Detail
-
MESSAGE_CODE
public static final String MESSAGE_CODE
- See Also:
getCode()
, Constant Field Values
-
-
Constructor Detail
-
ReadOnlyException
public ReadOnlyException(Object object)
The constructor.- Parameters:
object
- is the object that is read-only and can not be modified.
-
ReadOnlyException
public ReadOnlyException(Object object, Object attribute)
The constructor.- Parameters:
object
- is the object that is read-only and can not be modified.attribute
- is the attribute ofobject
that can not be modified.- Since:
- 3.1.0
-
ReadOnlyException
public ReadOnlyException(Throwable cause, Object object)
The constructor.- Parameters:
cause
- is thecause
of this exception.object
- is the object that is read-only and can not be modified.
-
-
Method Detail
-
getCode
public String getCode()
Description copied from class:ApplicationException
This method gets the code that identifies the detailed type of this object. WhileUUID
is unique per instance of aApplicationException
this code is a short and readable identifier representing theApplicationException
Class
. The default implementation returns thesimple name
. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned asString
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.- Overrides:
getCode
in classApplicationException
- Returns:
- the error code.
-
-