org.apache.struts2
Interface Messages


public interface Messages

Collection of messages. Supports nesting messages by field name.

Uses keys when adding instead of actual messages to decouple code from messages.

Author:
crazybob@google.com (Bob Lee)

Nested Class Summary
static class Messages.Severity
          Message severity.
 
Method Summary
 void add(Messages.Severity severity, java.lang.String key)
          Adds message.
 void add(Messages.Severity severity, java.lang.String key, java.lang.String... arguments)
          Adds request-scoped message.
 void addError(java.lang.String key)
          Adds error message.
 void addError(java.lang.String key, java.lang.String... arguments)
          Adds error message.
 void addInformation(java.lang.String key)
          Adds informational message.
 void addInformation(java.lang.String key, java.lang.String... arguments)
          Adds informational message.
 void addWarning(java.lang.String key)
          Adds warning message.
 void addWarning(java.lang.String key, java.lang.String... arguments)
          Adds warning message.
 Messages forField(java.lang.String fieldName)
          Gets nested messages for the given field.
 java.util.Map<java.lang.String,Messages> forFields()
          Gets map of field name to messages for that field.
 java.util.List<java.lang.String> forSeverity(Messages.Severity severity)
          Gets message strings for the given severity.
 java.util.List<java.lang.String> getErrors()
          Gets error message strings for this Messages instance.
 java.util.List<java.lang.String> getInformation()
          Gets informational message strings for this Messages instance.
 java.util.Set<Messages.Severity> getSeverities()
          Gets set of severities for which this Messages instance has messages.
 java.util.List<java.lang.String> getWarnings()
          Gets error message strings for this Messages instance.
 boolean hasErrors()
          Returns true if this or a nested Messages instance has error messages.
 boolean hasInformation()
          Returns true if this or a nested Messages instance has informational messages.
 boolean hasWarnings()
          Returns true if this or a nested Messages instance has warning messages.
 boolean isEmpty()
          Returns true if this and all nested Messages instances have no messages.
 boolean isEmpty(Messages.Severity severity)
          Returns true if this and all nested Messages instances have no messages for the given severity.
 

Method Detail

forField

Messages forField(java.lang.String fieldName)
Gets nested messages for the given field.

Supports dot notation to represent nesting. For example:

 messages.forField("foo").forField("bar") == messages.forField("foo.bar")
 

Parameters:
fieldName - name of the field
Returns:
nested Messages for given field name

forFields

java.util.Map<java.lang.String,Messages> forFields()
Gets map of field name to messages for that field.

Returns:
map of field name to Messages

addInformation

void addInformation(java.lang.String key)
Adds informational message.

Parameters:
key - message key
See Also:
Severity.INFO

addInformation

void addInformation(java.lang.String key,
                    java.lang.String... arguments)
Adds informational message.

Parameters:
key - message key
arguments - message arguments
See Also:
Severity.INFO

addWarning

void addWarning(java.lang.String key)
Adds warning message.

Parameters:
key - message key
See Also:
Severity.WARN

addWarning

void addWarning(java.lang.String key,
                java.lang.String... arguments)
Adds warning message.

Parameters:
key - message key
arguments - message arguments
See Also:
Severity.WARN

addError

void addError(java.lang.String key)
Adds error message.

Parameters:
key - message key
See Also:
Severity.ERROR

addError

void addError(java.lang.String key,
              java.lang.String... arguments)
Adds error message.

Parameters:
key - message key
arguments - message arguments
See Also:
Severity.ERROR

add

void add(Messages.Severity severity,
         java.lang.String key)
Adds message.

Parameters:
severity - message severity
key - message key

add

void add(Messages.Severity severity,
         java.lang.String key,
         java.lang.String... arguments)
Adds request-scoped message.

Parameters:
severity - message severity
key - message key
arguments - message arguments

getSeverities

java.util.Set<Messages.Severity> getSeverities()
Gets set of severities for which this Messages instance has messages. Not recursive.

Returns:
unmodifiable set of Messages.Severity sorted from least to most severe

forSeverity

java.util.List<java.lang.String> forSeverity(Messages.Severity severity)
Gets message strings for the given severity. Not recursive.

Parameters:
severity - message severity
Returns:
unmodifiable list of messages

getErrors

java.util.List<java.lang.String> getErrors()
Gets error message strings for this Messages instance. Not recursive.

Returns:
unmodifiable list of messages

getWarnings

java.util.List<java.lang.String> getWarnings()
Gets error message strings for this Messages instance. Not recursive.

Returns:
unmodifiable list of messages

getInformation

java.util.List<java.lang.String> getInformation()
Gets informational message strings for this Messages instance. Not recursive.

Returns:
unmodifiable list of messages

hasErrors

boolean hasErrors()
Returns true if this or a nested Messages instance has error messages.

See Also:
Severity.ERROR

hasWarnings

boolean hasWarnings()
Returns true if this or a nested Messages instance has warning messages.

See Also:
Severity.WARN

hasInformation

boolean hasInformation()
Returns true if this or a nested Messages instance has informational messages.

See Also:
Severity.INFO

isEmpty

boolean isEmpty()
Returns true if this and all nested Messages instances have no messages.


isEmpty

boolean isEmpty(Messages.Severity severity)
Returns true if this and all nested Messages instances have no messages for the given severity.

Parameters:
severity - message severity


Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.