|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
Messages forField(java.lang.String fieldName)
Supports dot notation to represent nesting. For example:
messages.forField("foo").forField("bar") == messages.forField("foo.bar")
fieldName
- name of the field
Messages
for given field namejava.util.Map<java.lang.String,Messages> forFields()
Messages
void addInformation(java.lang.String key)
key
- message keySeverity.INFO
void addInformation(java.lang.String key, java.lang.String... arguments)
key
- message keyarguments
- message argumentsSeverity.INFO
void addWarning(java.lang.String key)
key
- message keySeverity.WARN
void addWarning(java.lang.String key, java.lang.String... arguments)
key
- message keyarguments
- message argumentsSeverity.WARN
void addError(java.lang.String key)
key
- message keySeverity.ERROR
void addError(java.lang.String key, java.lang.String... arguments)
key
- message keyarguments
- message argumentsSeverity.ERROR
void add(Messages.Severity severity, java.lang.String key)
severity
- message severitykey
- message keyvoid add(Messages.Severity severity, java.lang.String key, java.lang.String... arguments)
severity
- message severitykey
- message keyarguments
- message argumentsjava.util.Set<Messages.Severity> getSeverities()
Messages
instance has messages. Not recursive.
Messages.Severity
sorted from least to most severejava.util.List<java.lang.String> forSeverity(Messages.Severity severity)
severity
- message severity
java.util.List<java.lang.String> getErrors()
Messages
instance. Not recursive.
java.util.List<java.lang.String> getWarnings()
Messages
instance. Not recursive.
java.util.List<java.lang.String> getInformation()
Messages
instance. Not recursive.
boolean hasErrors()
Messages
instance has error messages.
Severity.ERROR
boolean hasWarnings()
Messages
instance has warning messages.
Severity.WARN
boolean hasInformation()
Messages
instance has informational messages.
Severity.INFO
boolean isEmpty()
Messages
instances have no messages.
boolean isEmpty(Messages.Severity severity)
Messages
instances have no messages for the given severity.
severity
- message severity
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |