javax.portlet

Class ValidatorException

public class ValidatorException extends PortletException

The ValidatorException is thrown by the validate method of a PreferencesValidator when the validation of a preference failed.
Field Summary
ArrayListfailedKeyVector
Constructor Summary
ValidatorException()
ValidatorException(String text, Collection failedKeys)
Constructs a new validator exception with the given text.
ValidatorException(String text, Throwable cause, Collection failedKeys)
Constructs a new portlet validator exception.
ValidatorException(Throwable cause, Collection failedKeys)
Constructs a new portlet validator exception when the portlet needs to throw an exception.
Method Summary
EnumerationgetFailedKeys()
Returns the keys that failed the validation.

Field Detail

failedKeyVector

private transient ArrayList failedKeyVector

Constructor Detail

ValidatorException

private ValidatorException()

ValidatorException

public ValidatorException(String text, Collection failedKeys)
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 text failedKeys keys that failed the validation; may be null

ValidatorException

public ValidatorException(String text, Throwable cause, Collection failedKeys)
Constructs a new portlet validator exception. Used, when the portlet needs to do one of the following:

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 text cause the root cause failedKeys keys that failed the validation; may be null

ValidatorException

public ValidatorException(Throwable cause, Collection failedKeys)
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 cause failedKeys keys that failed the validation; may be null

Method Detail

getFailedKeys

public Enumeration 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.