InvalidPropertyException.java :  » REST » alc-rest » javax » resource » spi » Java Open Source

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.resource.spi;

import java.beans.PropertyDescriptor;

/**
 * This exception is thrown to indicate invalid configuration property settings.
 * 
 * @version 0.2
 * @author Ram Jeyaraman
 */
public class InvalidPropertyException extends javax.resource.ResourceException {

  /*
   * Holder for invalid properties.
   */
  private PropertyDescriptor[] invalidProperties;

  /**
   * Create a InvalidPropertyException.
   */
  public InvalidPropertyException() {
    super();
  }

  /**
   * Create a InvalidPropertyException.
   * 
   * @param message
   *            a description of the exception
   */
  public InvalidPropertyException(String message) {
    super(message);
  }

  /**
   * Constructs a new throwable with the specified cause.
   * 
   * @param cause
   *            a chained exception of type <code>Throwable</code>.
   */
  public InvalidPropertyException(Throwable cause) {
    super(cause);
  }

  /**
   * Constructs a new throwable with the specified detail message and cause.
   * 
   * @param message
   *            the detail message.
   * 
   * @param cause
   *            a chained exception of type <code>Throwable</code>.
   */
  public InvalidPropertyException(String message, Throwable cause) {
    super(message, cause);
  }

  /**
   * Constructs a new throwable with the specified detail message and an error
   * code.
   * 
   * @param message
   *            a description of the exception.
   * @param errorCode
   *            a string specifying the vendor specific error code.
   */
  public InvalidPropertyException(String message, String errorCode) {
    super(message, errorCode);
  }

  /**
   * Set a list of invalid properties.
   */
  public void setInvalidPropertyDescriptors(
      PropertyDescriptor[] invalidProperties) {
    this.invalidProperties = invalidProperties;
  }

  /**
   * Get the list of invalid properties.
   */
  public PropertyDescriptor[] getInvalidPropertyDescriptors() {
    return this.invalidProperties;
  }
}