FacesMessage represents a single validation (or other) message, which is typically associated with a particular component in the view. A jakarta.faces.application.FacesMessage instance may be created based on a specific messageId. The specification defines the set of messageIds for which there must be jakarta.faces.application.FacesMessage instances.

The implementation must take the following steps when creating FacesMessage instances given a messageId:

Call Application#getMessageBundle. If non-null, locate the named ResourceBundle, using the Locale from the current jakarta.faces.component.UIViewRoot and see if it has a value for the argument messageId. If it does, treat the value as the summary of the FacesMessage. If it does not, or if Application#getMessageBundle returned null, look in the ResourceBundle named by the value of the constant FACES_MESSAGES and see if it has a value for the argument messageId. If it does, treat the value as the summary of the FacesMessage. If it does not, there is no initialization information for the FacesMessage instance.

In all cases, if a ResourceBundle hit is found for the {messageId}, look for further hits under the key {messageId}_detail. Use this value, if present, as the detail for the returned FacesMessage.

Make sure to perform any parameter substitution required for the summary and detail of the FacesMessage.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	FacesMessage.Severity Class used to represent message severity levels in a typesafe enumeration.

Field Summary

Modifier and Type	Field and Description
private transient String	detail
public static final String	FACES_MESSAGES `ResourceBundle` identifier for messages whose message identifiers are defined in the Jakarta Faces specification.
private transient boolean	rendered
private static final long	serialVersionUID
private transient FacesMessage.Severity	severity
public static final FacesMessage.Severity	SEVERITY_ERROR Message severity level indicating that an error has occurred.
private static final String	SEVERITY_ERROR_NAME
public static final FacesMessage.Severity	SEVERITY_FATAL Message severity level indicating that a serious error has occurred.
private static final String	SEVERITY_FATAL_NAME
public static final FacesMessage.Severity	SEVERITY_INFO Message severity level indicating an informational message rather than an error.
private static final String	SEVERITY_INFO_NAME
public static final FacesMessage.Severity	SEVERITY_WARN Message severity level indicating that an error might have occurred.
private static final String	SEVERITY_WARN_NAME
private transient String	summary
private static final FacesMessage.Severity[]	values Array of all defined values, ascending order of ordinal value.
public static final List<FacesMessage.Severity>	VALUES Immutable `List` of valid `jakarta.faces.application.FacesMessage.Severity` instances, in ascending order of their ordinal value.
public static final Map<String, FacesMessage.Severity>	VALUES_MAP Immutable `Map` of valid `jakarta.faces.application.FacesMessage.Severity` instances, keyed by name.

Constructor Summary

Access	Constructor and Description
public	FacesMessage() Construct a new `jakarta.faces.application.FacesMessage` with no initial values.
public	FacesMessage(String the summary. summary) Construct a new `jakarta.faces.application.FacesMessage` with just a summary.
public	FacesMessage(String Localized summary message text summary, String Localized detail message text detail) Construct a new `jakarta.faces.application.FacesMessage` with the specified initial values.
public	FacesMessage(FacesMessage.Severity the severity severity, String Localized summary message text summary, String Localized detail message text detail) Construct a new `FacesMessage` with the specified initial values.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. object) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the localized detail text. getDetail() Return the localized detail text.
public FacesMessage.Severity	Returns: the severity level. getSeverity() Return the severity level.
public String	Returns: the localized summary text. getSummary() Return the localized summary text.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: `true` if `rendered()` has been called, otherwise `false` isRendered()
private void	readObject(ObjectInputStream The binary input of the object to be read in) Reconstruct `jakarta.faces.application.FacesMessage` from serialized artifacts.
public void	rendered() Marks this message as having been rendered to the client.
public void	setDetail(String The new localized detail text detail) Set the localized detail text.
public void	setSeverity(FacesMessage.Severity The new severity level severity) Set the severity level.
public void	setSummary(String The new localized summary text summary) Set the localized summary text.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	writeObject(ObjectOutputStream The target stream to which the object will be written. out) Persist `jakarta.faces.application.FacesMessage` artifacts, including the non serializable `Severity`.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

detail	back to summary
private transient String detail

FACES_MESSAGES	back to summary
public static final String FACES_MESSAGES `ResourceBundle` identifier for messages whose message identifiers are defined in the Jakarta Faces specification.

rendered	back to summary
private transient boolean rendered

serialVersionUID	back to summary
private static final long serialVersionUID

severity	back to summary
private transient FacesMessage.Severity severity

SEVERITY_ERROR	back to summary
public static final FacesMessage.Severity SEVERITY_ERROR Message severity level indicating that an error has occurred.

SEVERITY_ERROR_NAME	back to summary
private static final String SEVERITY_ERROR_NAME

SEVERITY_FATAL	back to summary
public static final FacesMessage.Severity SEVERITY_FATAL Message severity level indicating that a serious error has occurred.

SEVERITY_FATAL_NAME	back to summary
private static final String SEVERITY_FATAL_NAME

SEVERITY_INFO	back to summary
public static final FacesMessage.Severity SEVERITY_INFO Message severity level indicating an informational message rather than an error.

SEVERITY_INFO_NAME	back to summary
private static final String SEVERITY_INFO_NAME

SEVERITY_WARN	back to summary
public static final FacesMessage.Severity SEVERITY_WARN Message severity level indicating that an error might have occurred.

SEVERITY_WARN_NAME	back to summary
private static final String SEVERITY_WARN_NAME

summary	back to summary
private transient String summary

values	back to summary
private static final FacesMessage.Severity[] values Array of all defined values, ascending order of ordinal value. Be sure you include any new instances created above, in the same order.

VALUES	back to summary
public static final List<FacesMessage.Severity> VALUES Immutable `List` of valid `jakarta.faces.application.FacesMessage.Severity` instances, in ascending order of their ordinal value.

VALUES_MAP	back to summary
public static final Map<String, FacesMessage.Severity> VALUES_MAP Immutable `Map` of valid `jakarta.faces.application.FacesMessage.Severity` instances, keyed by name.

Constructor Detail

FacesMessage	back to summary
public FacesMessage() Construct a new `jakarta.faces.application.FacesMessage` with no initial values. The severity is set to Severity.INFO.

FacesMessage back to summary

FacesMessage	back to summary
public FacesMessage(String summary) Construct a new `jakarta.faces.application.FacesMessage` with just a summary. The detail is `null`, the severity is set to `Severity.INFO`. Parameters summary:String the summary.

public FacesMessage(String summary)

Construct a new jakarta.faces.application.FacesMessage with just a summary. The detail is null, the severity is set to Severity.INFO.

Parameters

summary:String: the summary.

FacesMessage back to summary

FacesMessage	back to summary
public FacesMessage(String summary, String detail) Construct a new `jakarta.faces.application.FacesMessage` with the specified initial values. The severity is set to Severity.INFO. Parameters summary:String Localized summary message text detail:String Localized detail message text Exceptions IllegalArgumentException: if the specified severity level is not one of the supported values

public FacesMessage(String summary, String detail)

Construct a new jakarta.faces.application.FacesMessage with the specified initial values. The severity is set to Severity.INFO.

Parameters

summary:String: Localized summary message text
detail:String: Localized detail message text

Exceptions

IllegalArgumentException:: if the specified severity level is not one of the supported values

FacesMessage back to summary

FacesMessage	back to summary
public FacesMessage(FacesMessage.Severity severity, String summary, String detail) Construct a new `FacesMessage` with the specified initial values. Parameters severity:FacesMessage.Severity the severity summary:String Localized summary message text detail:String Localized detail message text Exceptions IllegalArgumentException: if the specified severity level is not one of the supported values

public FacesMessage(FacesMessage.Severity severity, String summary, String detail)

Construct a new FacesMessage with the specified initial values.

Parameters

severity:FacesMessage.Severity: the severity
summary:String: Localized summary message text
detail:String: Localized detail message text

Exceptions

IllegalArgumentException:: if the specified severity level is not one of the supported values

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters object:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override Since 4.1

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

object:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Since

4.1

getDetail	back to summary
public String getDetail() Return the localized detail text. If no localized detail text has been defined for this message, return the localized summary text instead. Returns:String the localized detail text.

getDetail

back to summary

public String getDetail()

Return the localized detail text. If no localized detail text has been defined for this message, return the localized summary text instead.

Returns:String: the localized detail text.

getSeverity	back to summary
public FacesMessage.Severity getSeverity() Return the severity level. Returns:FacesMessage.Severity the severity level.

getSeverity

back to summary

public FacesMessage.Severity getSeverity()

Return the severity level.

Returns:FacesMessage.Severity: the severity level.

getSummary	back to summary
public String getSummary() Return the localized summary text. Returns:String the localized summary text.

getSummary

back to summary

public String getSummary()

Return the localized summary text.

Returns:String: the localized summary text.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override Since 4.1

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Since

4.1

isRendered	back to summary
public boolean isRendered() Returns:boolean `true` if `rendered()` has been called, otherwise `false` Since 2.0

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException Reconstruct `jakarta.faces.application.FacesMessage` from serialized artifacts. Parameters in:ObjectInputStream The binary input of the object to be read Exceptions IOException: Any of the usual Input/Output related exceptions. ClassNotFoundException: Class of a serialized object cannot be found.

private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException

Reconstruct jakarta.faces.application.FacesMessage from serialized artifacts.

Parameters

in:ObjectInputStream: The binary input of the object to be read

Exceptions

IOException:: Any of the usual Input/Output related exceptions.
ClassNotFoundException:: Class of a serialized object cannot be found.

rendered	back to summary
public void rendered() Marks this message as having been rendered to the client. Since 2.0

rendered

back to summary

public void rendered()

Marks this message as having been rendered to the client.

Since: 2.0

setDetail	back to summary
public void setDetail(String detail) Set the localized detail text. Parameters detail:String The new localized detail text

setDetail

back to summary

public void setDetail(String detail)

Set the localized detail text.

Parameters

detail:String: The new localized detail text

setSeverity	back to summary
public void setSeverity(FacesMessage.Severity severity) Set the severity level. Parameters severity:FacesMessage.Severity The new severity level Exceptions IllegalArgumentException: if the specified severity level is not one of the supported values

setSeverity

back to summary

public void setSeverity(FacesMessage.Severity severity)

Set the severity level.

Parameters

severity:FacesMessage.Severity: The new severity level

Exceptions

IllegalArgumentException:: if the specified severity level is not one of the supported values

setSummary	back to summary
public void setSummary(String summary) Set the localized summary text. Parameters summary:String The new localized summary text

setSummary

back to summary

public void setSummary(String summary)

Set the localized summary text.

Parameters

summary:String: The new localized summary text

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override Since 4.1

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

Since

4.1

writeObject back to summary

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException Persist `jakarta.faces.application.FacesMessage` artifacts, including the non serializable `Severity`. Parameters out:ObjectOutputStream The target stream to which the object will be written. Exceptions IOException: Any of the usual Input/Output related exceptions.

private void writeObject(ObjectOutputStream out) throws IOException

Persist jakarta.faces.application.FacesMessage artifacts, including the non serializable Severity.

Parameters

out:ObjectOutputStream: The target stream to which the object will be written.

Exceptions

IOException:: Any of the usual Input/Output related exceptions.

jakarta.faces.application back to summary

public Class FacesMessage.Severity

Class Inheritance

extends Object
implements Comparable

java.lang.Object
jakarta.faces.application.FacesMessage.Severity

All Implemented Interfaces

java.lang.Comparable

Class used to represent message severity levels in a typesafe enumeration.

Field Summary

Modifier and Type	Field and Description
private static int	nextOrdinal Static counter returning the ordinal value to be assigned to the next instance that is created.
private final int	ordinal The ordinal value assigned to this instance.
pack-priv String	severityName The (optional) name for this severity.

Constructor Summary

Access	Constructor and Description
private	Severity(String newSeverityName) Private constructor to disable the creation of new instances.

Method Summary

Modifier and Type	Method and Description
public int	compareTo(Object The other object to be compared to severity) Implements java.lang.Comparable.compareTo. Compare this `jakarta.faces.application.FacesMessage.Severity` instance to the specified one.
public int	Returns: the ordinal. getOrdinal() Return the ordinal value of this `FacesMessage.Severity` instance.
public String	toString() Overrides java.lang.Object.toString. Return a String representation of this `FacesMessage.Severity` instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

nextOrdinal	back to summary
private static int nextOrdinal Static counter returning the ordinal value to be assigned to the next instance that is created.

ordinal	back to summary
private final int ordinal The ordinal value assigned to this instance.

severityName	back to summary
pack-priv String severityName The (optional) name for this severity.

Constructor Detail

Severity	back to summary
private Severity(String newSeverityName) Private constructor to disable the creation of new instances.

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(Object severity) Implements java.lang.Comparable.compareTo. Compare this `jakarta.faces.application.FacesMessage.Severity` instance to the specified one. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object. Parameters severity:Object The other object to be compared to Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(Object severity)

Implements java.lang.Comparable.compareTo.

Compare this jakarta.faces.application.FacesMessage.Severity instance to the specified one. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.

Parameters

severity:Object: The other object to be compared to

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

getOrdinal back to summary

getOrdinal	back to summary
public int getOrdinal() Return the ordinal value of this `FacesMessage.Severity` instance. Returns:int the ordinal.

public int getOrdinal()

Return the ordinal value of this FacesMessage.Severity instance.

Returns:int: the ordinal.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a String representation of this `FacesMessage.Severity` instance. Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this FacesMessage.Severity instance.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override