Message (org.faktorips.runtime 3.17.1-SNAPSHOT API)

java.lang.Object
- org.faktorips.runtime.Message

All Implemented Interfaces:

Serializable
```
public class Message
extends Object
implements Serializable
```
A human readable text message with an optional code that identifies the type of the message and a severity that indicates if this is an error, warning or information.
In addition a message provides access to the objects and their properties the message relates to. E.g. if a message reads that "insured person's age must be at least 18" than the person's age is invalid. This information can be used for example to mark controls in the UI that display this property.
If the provided message has replacement parameters that cannot be evaluated while creating the message text, it is possible to provide there parameters to the message object. Have a look at MsgReplacementParameter for further information.
If you need any further information stored with the message, it is possible to implement the IMarker object and provide some additional markers to the message. The exact use of the markers depends on the custom implementation.
Message is an immutable value object. Two message objects are considered equal if they have the same severity, code, text, "invalid properties" and replacement parameters.

See Also:
MsgReplacementParameter, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Message.Builder
A builder for the Message class.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Message.Builder` A builder for the `Message` class.

Field Summary

Fields
Modifier and Type	Field and Description
`static Severity`	`ERROR` Severity error.
`static Severity`	`INFO` Severity info.
`static Severity`	`NONE` Severity none.
`static Severity`	`WARNING` Severity warning.

Constructor Summary

Constructors
Constructor and Description
`Message(Message.Builder builder)` Creates a new message by using the fields of a `Message.Builder`.
`Message(Message msg)` Creates a new message by copying everything of the given `Message`.
`Message(String text, Severity severity)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, List<ObjectProperty> invalidObjectProperties)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, List<ObjectProperty> invalidObjectProperties, List<MsgReplacementParameter> replacementParameters)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, List<ObjectProperty> invalidObjectProperties, List<MsgReplacementParameter> parameters, Set<? extends IMarker> markers)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, Object invalidObject)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, ObjectProperty invalidObjectProperty)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, ObjectProperty[] invalidObjectProperties)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, ObjectProperty[] invalidObjectProperties, MsgReplacementParameter[] parameters)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, ObjectProperty invalidObjectProperty, List<MsgReplacementParameter> parameters)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, ObjectProperty invalidObjectProperty, MsgReplacementParameter... parameters)` Creates a new message by defining the following parameters.
`Message(String code, String text, Severity severity, Object invalidObject, String... invalidObjectProperties)` Creates a new message by defining the following parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`static Message`	`createCopy(Message msg, Object oldObject, Object newObject)` Creates a copy from the message and replaces all references to the old object with the new object.
`boolean`	`equals(Object o)` Returns true if o is a Message and severity, code and text are equal.
`static Message.Builder`	`error(String text)` Creates a new `Message.Builder` with `ERROR` and the given message.
`String`	`getCode()` Returns the message code.
`List<ObjectProperty>`	`getInvalidObjectProperties()` Returns the list of object properties the message refers to.
`Set<? extends IMarker>`	`getMarkers()` Returns a set of `IMarker`s associated with this class.
`int`	`getNumOfInvalidObjectProperties()` Returns the number of referenced invalid object properties.
`int`	`getNumOfReplacementParameters()` Returns the number of replacement parameters..
`List<MsgReplacementParameter>`	`getReplacementParameters()` Returns the list of replacement parameters.
`Object`	`getReplacementValue(String paramName)` Returns the value for the given replacement parameter.
`Severity`	`getSeverity()` Returns the message's severity as one of the constants ERROR, WARNING, INFO or NONE.
`String`	`getText()` Returns the humand readable message text.
`int`	`hashCode()`
`boolean`	`hasMarker(IMarker marker)` Returns `true` if the message contains the specified `IMarker` marker otherwise `false`.
`boolean`	`hasMarkers()` Returns `true` if the message has markers otherwise `false`.
`boolean`	`hasReplacementParameter(String paramName)` Returns `true` if the message has a replacement parameter with the given name, otherwise `false`.
`static Message.Builder`	`info(String text)` Creates a new `Message.Builder` with `INFO` and the given message.
`static Message`	`newError(String code, String text)` Constructs a new error message.
`static Message`	`newInfo(String code, String text)` Constructs a new information message.
`static Message`	`newWarning(String code, String text)` Constructs a new warning message.
`String`	`toString()`
`static Message.Builder`	`warning(String text)` Creates a new `Message.Builder` with `WARNING` and the given message.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE
```
public static final Severity NONE
```
    Severity none.
  - INFO
```
public static final Severity INFO
```
    Severity info.
  - WARNING
```
public static final Severity WARNING
```
    Severity warning.
  - ERROR
```
public static final Severity ERROR
```
    Severity error.
- Constructor Detail
  - Message
```
public Message(Message.Builder builder)
```
    Creates a new message by using the fields of a Message.Builder.
    
    Parameters:
    builder - the Message.Builder
  - Message
```
public Message(Message msg)
```
    Creates a new message by copying everything of the given Message.
    
    Parameters:
    msg - the Message to copy from
  - Message
```
public Message(String text,
       Severity severity)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
  - Message
```
public Message(String code,
       String text,
       Severity severity)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       Object invalidObject)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObject - An object properties the message refers to
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       ObjectProperty invalidObjectProperty)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperty - An object property the message refers to
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       Object invalidObject,
       String... invalidObjectProperties)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO: ERROR, WARNING or INFO
    invalidObject - the Object of the ObjectProperty
    invalidObjectProperties - An array of propertie's names the message refers to
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       ObjectProperty[] invalidObjectProperties)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperties - An array of object properties the message refers to
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       List<ObjectProperty> invalidObjectProperties)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperties - A list of object properties the message refers to
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       List<ObjectProperty> invalidObjectProperties,
       List<MsgReplacementParameter> replacementParameters)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperties - A list of object properties the message refers to
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       ObjectProperty invalidObjectProperty,
       MsgReplacementParameter... parameters)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperty - A list of object properties the message refers to
    parameters - an array of replacement parameters
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       ObjectProperty invalidObjectProperty,
       List<MsgReplacementParameter> parameters)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperty - An object properties the message refers to
    parameters - a list of replacement parameters
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       ObjectProperty[] invalidObjectProperties,
       MsgReplacementParameter[] parameters)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperties - An array of object properties the message refers to
    parameters - an array of replacement parameters
  - Message
```
public Message(String code,
       String text,
       Severity severity,
       List<ObjectProperty> invalidObjectProperties,
       List<MsgReplacementParameter> parameters,
       Set<? extends IMarker> markers)
```
    Creates a new message by defining the following parameters.
    
    Parameters:
    code - A message code that identifies the kind of the message
    text - The human readable text of this message
    severity - The message's severity: ERROR, WARNING or INFO
    invalidObjectProperties - A list of object properties the message refers to
    parameters - a list of replacement parameters
    markers - a list of markers. If this parameter is null an empty list is set as markers. The List of markers is
- Method Detail
  - error
```
public static final Message.Builder error(String text)
```
    Creates a new Message.Builder with ERROR and the given message.
    To create a new Message you can use for example:
    Message.error("MessageText").code("1").invalidObjects("object", "property").create();
    
    Parameters:
    text - The human readable text of this message
  - warning
```
public static final Message.Builder warning(String text)
```
    Creates a new Message.Builder with WARNING and the given message.
    To create a new Message you can use for example:
    Message.warning("MessageText").code("1").invalidObjects("object", "property").create();
    
    Parameters:
    text - The human readable text of this message
  - info
```
public static final Message.Builder info(String text)
```
    Creates a new Message.Builder with INFO and the given message.
    To create a new Message you can use for example:
    Message.info("MessageText").code("1").invalidObjects("object", "property").create();
    
    Parameters:
    text - The human readable text of this message
  - createCopy
```
public static final Message createCopy(Message msg,
                 Object oldObject,
                 Object newObject)
```
    Creates a copy from the message and replaces all references to the old object with the new object.
  - newInfo
```
public static final Message newInfo(String code,
              String text)
```
    Constructs a new information message.
  - newWarning
```
public static final Message newWarning(String code,
                 String text)
```
    Constructs a new warning message.
  - newError
```
public static final Message newError(String code,
               String text)
```
    Constructs a new error message.
  - getSeverity
```
public Severity getSeverity()
```
    Returns the message's severity as one of the constants ERROR, WARNING, INFO or NONE.
  - getText
```
public String getText()
```
    Returns the humand readable message text.
  - getCode
```
public String getCode()
```
    Returns the message code.
  - getNumOfInvalidObjectProperties
```
public int getNumOfInvalidObjectProperties()
```
    Returns the number of referenced invalid object properties.
  - getInvalidObjectProperties
```
public List<ObjectProperty> getInvalidObjectProperties()
```
    Returns the list of object properties the message refers to. E.g. if a message reads "The driver's age must be greater than 18.", this method would probably return the driver object and the property name age. Returns an empty array if this message does not refer to any objects / properties.
  - getNumOfReplacementParameters
```
public int getNumOfReplacementParameters()
```
    Returns the number of replacement parameters..
  - getReplacementParameters
```
public List<MsgReplacementParameter> getReplacementParameters()
```
    Returns the list of replacement parameters. Returns an empty list if this message hasn't got any replacements.
  - hasReplacementParameter
```
public boolean hasReplacementParameter(String paramName)
```
    Returns true if the message has a replacement parameter with the given name, otherwise false. Returns false if paramName is null.
  - getReplacementValue
```
public Object getReplacementValue(String paramName)
```
    Returns the value for the given replacement parameter. Returns null if the message hasn't got a parameter with the indicated name.
    
    See Also:
    hasReplacementParameter(String)
  - getMarkers
```
public Set<? extends IMarker> getMarkers()
```
    Returns a set of IMarkers associated with this class. Returns an empty set if no markers are set.
  - hasMarker
```
public boolean hasMarker(IMarker marker)
```
    Returns true if the message contains the specified IMarker marker otherwise false.
  - hasMarkers
```
public boolean hasMarkers()
```
    Returns true if the message has markers otherwise false.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Returns true if o is a Message and severity, code and text are equal.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

INFO

WARNING

ERROR

Constructor Detail

Message

Message

Message

Message

Message

Message

Message

Message

Message

Message

Message

Message

Message

Message

Method Detail

error

warning

info

createCopy

newInfo

newWarning

newError

getSeverity

getText

getCode

getNumOfInvalidObjectProperties

getInvalidObjectProperties

getNumOfReplacementParameters

getReplacementParameters

hasReplacementParameter

getReplacementValue

getMarkers

hasMarker

hasMarkers

toString

equals

hashCode