org.apache.myfaces.extensions.cdi.message.api
Interface Message

All Superinterfaces:
Localizable, Serializable
All Known Subinterfaces:
MessageWithSeverity
All Known Implementing Classes:
AbstractMessage, AbstractMessageWithSeverity

public interface Message
extends Localizable, Serializable

Basic interface for all message-types


Method Summary
 Message addArgument(Serializable... arguments)
           
 Message addPayload(Class key, MessagePayload payload)
           
 Serializable[] getArguments()
           
 String getDescriptor()
           
 Map<Class,MessagePayload> getPayload()
           
 
Methods inherited from interface org.apache.myfaces.extensions.cdi.message.api.Localizable
toString
 

Method Detail

getDescriptor

String getDescriptor()
Returns:
the message key (or inline-text) of the current message

getArguments

Serializable[] getArguments()
Returns:
all named and numbered arguments

addArgument

Message addArgument(Serializable... arguments)
Parameters:
arguments - 1-n new arguments for the current message
Returns:
the current instance

getPayload

Map<Class,MessagePayload> getPayload()
Returns:
the payload of the message

addPayload

Message addPayload(Class key,
                   MessagePayload payload)
Parameters:
key - of the payload
payload - value of the payload
Returns:
the current instance


Copyright © 2010-2012 The Apache Software Foundation. All Rights Reserved.