Message

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> mentawai >> [ message overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.mentawai.message.Message

SOURCE |

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.mentawai.message
Interface Message

All Known Implementing Classes:: AbstractMessage

public interface Message

Describes the behavior of a text message that can be displayed in web page. A messsage has an ID and a message context from where to get the message as text. Messages are localized and can have tokens.

Method Summary

MessageContext getContext()
          Gets the message context for this message.

java.lang.String getId()
          Gets the unique ID of this message.

java.lang.String getText(java.util.Locale loc)
          Gets the message text this message object represents.

void setTokens(java.util.Map tokens)
          Sets tokens or placeholders for this message.

Method Detail

getId

public java.lang.String getId()

Gets the unique ID of this message. A message context cannot have two messages with the same id.

getContext

public MessageContext getContext()

Gets the message context for this message.

getText

public java.lang.String getText(java.util.Locale loc)

Gets the message text this message object represents.

setTokens

public void setTokens(java.util.Map tokens)

Sets tokens or placeholders for this message. A message can have tokens.