Package javax.portlet
Class ValidatorException
java.lang.Object
java.lang.Throwable
java.lang.Exception
javax.portlet.PortletException
javax.portlet.ValidatorException
- All Implemented Interfaces:
Serializable
The
ValidatorException
is thrown by the
validate
method of a PreferencesValidator when
the validation of a preference failed.- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ValidatorException
(String text, Throwable cause, Collection failedKeys) Constructs a new portlet validator exception.ValidatorException
(String text, Collection failedKeys) Constructs a new validator exception with the given text.ValidatorException
(Throwable cause, Collection failedKeys) Constructs a new portlet validator exception when the portlet needs to throw an exception. -
Method Summary
Modifier and TypeMethodDescriptionReturns the keys that failed the validation.Methods inherited from class javax.portlet.PortletException
getCause, printStackTrace, printStackTrace, printStackTrace
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString
-
Field Details
-
failedKeyVector
-
-
Constructor Details
-
ValidatorException
private ValidatorException() -
ValidatorException
Constructs a new validator exception with the given text. The portlet container may use the text write it to a log.The collection of failed keys may contain all failed keys, only the first key that failed validation, or may be
null
.- Parameters:
text
- the exception textfailedKeys
- keys that failed the validation; may benull
-
ValidatorException
Constructs a new portlet validator exception. Used, when the portlet needs to do one of the following:- include a message about the "root cause" that interfered with its normal operation
- include a description message
throw an exception The Collection of failed keys may contain all failed keys, only the first key that failed validation, or may be
null
.- Parameters:
text
- the exception textcause
- the root causefailedKeys
- keys that failed the validation; may benull
-
ValidatorException
Constructs a new portlet validator exception when the portlet needs to throw an exception. The exception message is based on the localized message of the underlying exception.The Collection of failed keys may contain all failed keys, only the first key that failed validation, or may be
null
.- Parameters:
cause
- the root causefailedKeys
- keys that failed the validation; may benull
-
-
Method Details
-
getFailedKeys
Returns the keys that failed the validation.The Enumeration of failed keys may contain all failed keys, only the first key that failed validation, or an empty
Enumeration
if no failed keys are available.- Returns:
- the keys that failed validation, or an empty
Enumeration
if no failed keys are available.
-