javax.portlet.ValidatorException Maven / Gradle / Ivy
/* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* NOTE: this source code is based on an early draft version of JSR 286 and not intended for product
* implementations. This file may change or vanish in the final version of the JSR 286 specification.
*/
/*
* This source code implements specifications defined by the Java
* Community Process. In order to remain compliant with the specification
* DO NOT add / change / or delete method signatures!
*/
/**
* Copyright 2006 IBM Corporation.
*/
package javax.portlet;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
/**
* The ValidatorException is thrown by the
* validate method of a PreferencesValidator when
* the validation of a preference failed.
*/
public class ValidatorException extends PortletException
{
private transient ArrayList failedKeyVector = new ArrayList();
private static final long serialVersionUID = 1L;
private 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.
*
* @param text
* the exception text
* @param failedKeys
* keys that failed the validation; may be null
*/
public ValidatorException (String text, Collection failedKeys)
{
super (text);
if ( failedKeys != null )
failedKeyVector.addAll(failedKeys);
}
/**
* Constructs a new portlet validator exception.
* Used, when the portlet needs to do one of the following:
*
* - throw an exception
*
- include a message about the "root cause" that interfered
* with its normal operation
*
- include a description message
*
*
* The Collection of failed keys may contain all failed keys, only the
* first key that failed validation, or may be null.
*
* @param text
* the exception text
* @param cause
* the root cause
* @param failedKeys
* keys that failed the validation; may be null
*/
public ValidatorException (String text, Throwable cause, Collection failedKeys)
{
super(text, cause);
if ( failedKeys != null )
failedKeyVector.addAll(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.
*
* @param cause
* the root cause
* @param failedKeys
* keys that failed the validation; may be null
*/
public ValidatorException (Throwable cause, Collection failedKeys)
{
super(cause);
if ( failedKeys != null )
failedKeyVector.addAll(failedKeys);
}
/**
* 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.
*
* @return the keys that failed validation, or an empty
* Enumeration if no failed keys are available.
*/
public Enumeration getFailedKeys()
{
return Collections.enumeration(failedKeyVector);
}
}