001 /*
002 * JBoss DNA (http://www.jboss.org/dna)
003 * See the COPYRIGHT.txt file distributed with this work for information
004 * regarding copyright ownership. Some portions may be licensed
005 * to Red Hat, Inc. under one or more contributor license agreements.
006 * See the AUTHORS.txt file in the distribution for a full listing of
007 * individual contributors.
008 *
009 * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010 * is licensed to you under the terms of the GNU Lesser General Public License as
011 * published by the Free Software Foundation; either version 2.1 of
012 * the License, or (at your option) any later version.
013 *
014 * JBoss DNA is distributed in the hope that it will be useful,
015 * but WITHOUT ANY WARRANTY; without even the implied warranty of
016 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017 * Lesser General Public License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this software; if not, write to the Free
021 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023 */
024 package org.jboss.dna.common.jdbc.model.api;
025
026 /**
027 * Database metadata method call related exception
028 *
029 * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
030 */
031 public class DatabaseMetaDataMethodException extends Exception {
032 // ~ Instance fields ------------------------------------------------------------------
033 private static final long serialVersionUID = 5001714254060693493L;
034
035 public static final String METHOD_FAILED = "Database Metadata method failed";
036
037 /* database metadata method name that caused exception */
038 private String methodName;
039
040 // ~ Constructors ---------------------------------------------------------------------
041
042 /**
043 * Default constructor
044 */
045 public DatabaseMetaDataMethodException() {
046 this(METHOD_FAILED, null, null);
047 }
048
049 /**
050 * Constructor
051 *
052 * @param message the explanation of exception
053 * @param methodName the name of method that caused exception
054 */
055 public DatabaseMetaDataMethodException( String message,
056 String methodName ) {
057 this(message, methodName, null);
058 }
059
060 /**
061 * Constructor
062 *
063 * @param message the explanation of exception
064 * @param methodName the name of method that caused exception
065 * @param ex the exception that causes problem
066 */
067 public DatabaseMetaDataMethodException( String message,
068 String methodName,
069 Throwable ex ) {
070 super(message, ex);
071
072 // set method name
073 setMethodName(methodName);
074 }
075
076 /**
077 * Constructor
078 *
079 * @param ex the exception that causes problem
080 */
081 public DatabaseMetaDataMethodException( Throwable ex ) {
082 this(METHOD_FAILED, null, ex);
083 }
084
085 // ~ Methods --------------------------------------------------------------------------
086
087 /**
088 * Returns name of method that caused exception
089 *
090 * @return name of method that caused exception
091 */
092 public String getMethodName() {
093 return methodName;
094 }
095
096 /**
097 * Sets the name of method that caused exception
098 *
099 * @param methodName the name of method that caused exception
100 */
101 public void setMethodName( String methodName ) {
102 this.methodName = methodName;
103 }
104 }