Class MsgReplacementParameter

java.lang.Object
org.faktorips.runtime.MsgReplacementParameter
All Implemented Interfaces:
Serializable

public class MsgReplacementParameter extends Object implements Serializable
When creating a message the text might be created by replacing parameters (or placeholders) with concrete values, e.g. "The sum insured must be at least {minSumInsured}." where {minSumInsured} is replaced with the current minimum e.g. 200 Euro. If you need to represent the user a different text, you need the actual value for the parameter. To archieve this the message holds the parameters along with their actual value.

The following are scenarios where you might need to present a different text for a message:

  • You have limited space available for the text, for example if your display is a terminal.
  • You present the text to a different user group, e.g. internet users instead of your backoffice employees.
Author:
Jan Ortmann
See Also:
  • Constructor Details

    • MsgReplacementParameter

      public MsgReplacementParameter(String paramName, Object paramValue)
      Creates a new parameter value with name and value.
      Throws:
      NullPointerException - if paramName is null.
  • Method Details

    • getName

      public String getName()
      Returns the parameter's name. This method never returns null.
    • getValue

      public Object getValue()
      Returns the parameter's value.
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object