Class ValidatorException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- jakarta.faces.FacesException
-
- jakarta.faces.validator.ValidatorException
-
- All Implemented Interfaces:
Serializable
public class ValidatorException extends FacesException
A ValidatorException is an exception thrown by the
validate()
method of aValidator
to indicate that validation failed.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ValidatorException(FacesMessage message)
Construct a new exception with the specified message and no root cause.ValidatorException(FacesMessage message, Throwable cause)
Construct a new exception with the specified detail message and root cause.ValidatorException(Collection<FacesMessage> messages)
Allow this one exception to contain multiple messages.ValidatorException(Collection<FacesMessage> messages, Throwable cause)
Allow this one exception to contain multiple messages, while passing on the root cause to the superclass
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FacesMessage
getFacesMessage()
Returns theFacesMessage
associated with the exception.Collection<FacesMessage>
getFacesMessages()
If this instance was created with a constructor that takesCollection<FacesMessage>
, this method returns the passed collection, otherwise this method returnsnull
.-
Methods inherited from class jakarta.faces.FacesException
getCause
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
ValidatorException
public ValidatorException(FacesMessage message)
Construct a new exception with the specified message and no root cause.
- Parameters:
message
- The message for this exception
-
ValidatorException
public ValidatorException(Collection<FacesMessage> messages)
Allow this one exception to contain multiple messages.
- Parameters:
messages
- the list of messages for this exception- Since:
- 2.0
-
ValidatorException
public ValidatorException(FacesMessage message, Throwable cause)
Construct a new exception with the specified detail message and root cause.
- Parameters:
message
- The detail message for this exceptioncause
- The root cause for this exception
-
ValidatorException
public ValidatorException(Collection<FacesMessage> messages, Throwable cause)
Allow this one exception to contain multiple messages, while passing on the root cause to the superclass
- Parameters:
messages
- the detail messages for this exceptioncause
- the root cause for this exception- Since:
- 2.0
-
-
Method Detail
-
getFacesMessage
public FacesMessage getFacesMessage()
Returns the
FacesMessage
associated with the exception. If this instance was created with a constructor that takesCollection<FacesMessage>
, this method returns the first message in theCollection
- Returns:
- the message
-
getFacesMessages
public Collection<FacesMessage> getFacesMessages()
If this instance was created with a constructor that takes
Collection<FacesMessage>
, this method returns the passed collection, otherwise this method returnsnull
.- Returns:
- the messages
- Since:
- 2.0
-
-