Package com.pingidentity.sdk.locale

Class Message

java.lang.Object

com.pingidentity.sdk.locale.Message

public class Message
extends Object

An data structure to hold a message key and its message parameters. It can also contain other nested messages that have their own message key and parameters. This class is intended to be consumed by LanguagePackMessages where the message key should refer to a key found in pingfederate-message.properties.

Since:

9.3

Constructor Summary

Constructors

Constructor	Description
Message(String messageKey)	Construct an instance of Message with just a message key
Message(String messageKey, String[] params)	Construct an instance of Message with a message key and associated message parameters
Message(String messageKey, String[] params, List<Message> nestedMessages)	Construct an instance of Message with a message key, associated message parameters and a list of nested messages

Method Summary

Modifier and Type	Method	Description
String	getMessageKey()	Accessor for the messageKey
List<Message>	getNestedMessages()	Accessor of nestedMessage parameter
String[]	getParams()	Accessor of params

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Message

public Message(String messageKey)

Construct an instance of Message with just a message key

Parameters:

messageKey - The key of the message

Message

public Message(String messageKey,
 String[] params)

Construct an instance of Message with a message key and associated message parameters

Parameters:

messageKey - The key of the message

params - The parameters to be substituted into the message

Message

public Message(String messageKey,
 String[] params,
 List<Message> nestedMessages)

Construct an instance of Message with a message key, associated message parameters and a list of nested messages

Parameters:

messageKey - The key of the message

params - The parameters to be substituted into the message

nestedMessages - The list of nested messages associated with this one

Method Details

getMessageKey

public String getMessageKey()

Accessor for the messageKey

Returns:

The key of the message

getParams

public String[] getParams()

Accessor of params

Returns:

The parameters to be substituted into the message

getNestedMessages

public List<Message> getNestedMessages()

Accessor of nestedMessage parameter

Returns:

List of nested messages associated with this one