001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package com.sun.data.provider;
043:
044: /**
045: * <p>The DataProviderException is generic runtime exception that wraps an
046: * underlying cause exception for {@link DataProvider} methods. Each of the
047: * DataProvider methods throw this runtime exception to allow for clean
048: * wrapping of underlying exceptions. Since it is unknown what implementations
049: * of DataProvider will exist, it cannot be known what types of exceptions this
050: * will wrap.</p>
051: *
052: * <p>The decision to make this a RuntimeException was intentional so as not to
053: * force a <code>try...catch</code> block around every invocation of a
054: * DataProvider method, but still explicitly declare the throws clause on each
055: * method making it clear that the user should consult the documentation for the
056: * specific DataProvider implementation to see what exceptions might be thrown.
057: * </p>
058: *
059: * @author Joe Nuxoll
060: */
061: public class DataProviderException extends RuntimeException {
062:
063: /**
064: * Constructs a default DataProviderException with no message with no
065: * wrapped cause exception.
066: */
067: public DataProviderException() {
068: }
069:
070: /**
071: * Constructs a DataProviderException with the specified message and no
072: * wrapped cause exception.
073: *
074: * @param message The desired exception message
075: */
076: public DataProviderException(String message) {
077: super (message);
078: }
079:
080: /**
081: * Constructs a DataProviderException with the specified message and
082: * wrapped cause exception.
083: *
084: * @param message The desired exception message
085: * @param cause The underlying cause exception
086: */
087: public DataProviderException(String message, Throwable cause) {
088: super (message, cause);
089: }
090:
091: /**
092: * Constructs a DataProviderException with the specified wrapped cause
093: * exception.
094: *
095: * @param cause The underlying cause exception
096: */
097: public DataProviderException(Throwable cause) {
098: super(cause);
099: }
100: }
|