/* NamingException.java -- Superclass of all naming Exceptions Copyright (C) 2000, 2001 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. As a special exception, if you link this library with other files to produce an executable, this library does not by itself cause the resulting executable to be covered by the GNU General Public License. This exception does not however invalidate any other reasons why the executable file might be covered by the GNU General Public License. */ package javax.naming; import java.io.PrintStream; import java.io.PrintWriter; /** * Superclass of all naming Exceptions. * Can contain extra information about the root cause of this exception * (for example when the original exception was not a subclass of * NamingException), the part of the Name that * could be resolved (including the Object it resolved to) * and the part of the Name that could not be resolved when * the exception occurred. * * @since 1.3 * @author Anthony Green (green@redhat.com) * @author Mark Wielaard (mark@klomp.org) */ public class NamingException extends Exception { /** * The root cause of this exception. Might be null. Set by calling * setRootCause(), can be accessed by calling * getRootCause(). */ protected Throwable rootException; /** * If the exception was caused while resolving a Name then * this field contains that part of the name that could be resolved. * Field might be null. Set by calling setResolvedName(). * Can be accessed by calling getResolvedName. */ protected Name resolvedName; /** * If the exception was caused while resolving a Name then * this field contains the object that part of the name could be resolved to. * Field might be null. Set by calling setResolvedObj(). * Can be accessed by calling getResolvedObj. */ protected Object resolvedObj; /** * If the exception was caused while resolving a Name then * this field contains that part of the name that could not be resolved. * Field might be null. Set by calling setRemainingName(). * The field can be extended by calling appendRemainingName() * or appendRemainingComponent(). * Can be accessed by calling getRemainingName. */ protected Name remainingName; /** * Creates a new NamingException without a message. Does not set any of the * rootException, resolvedName, * resolvedObj or remainingObject, fields. * These fields can be set later. */ public NamingException () { super(); } /** * Creates a new NamingException with a detailed message. Does not set * the rootException, resolvedName, * resolvedObj or remainingObject, fields. * These fields can be set later. */ public NamingException (String msg) { super(msg); } /** * Gets the root cause field rootException of this Exception. */ public Throwable getRootCause () { return rootException; } /** * Sets the root cause field rootException of this Exception. */ public void setRootCause (Throwable e) { rootException = e; } /** * Gets the part of the name that could be resolved before this exception * happend. Returns the resolvedName field of this Exception. */ public Name getResolvedName () { return resolvedName; } /** * Sets the part of the name that could be resolved before this exception * happend. Sets the resolvedName field of this Exception. */ public void setResolvedName (Name name) { resolvedName = name; } /** * Gets the Object to which (part of) the name could be resolved before this * exception happend. Returns the resolvedObj field of this * Exception. */ public Object getResolvedObj () { return resolvedObj; } /** * Sets the Object to which (part of) the name could be resolved before this * exception happend. Sets the resolvedObj field of this * Exception. */ public void setResolvedObj (Object o) { resolvedObj = o; } /** * Gets the part of the name that could not be resolved before this exception * happend. Returns the remainingName field of this Exception. */ public Name getRemainingName () { return remainingName; } /** * Sets the part of the name that could be resolved before this exception * happend. Sets the resolvedName field of this Exception. * The field can be extended by calling appendRemainingName() * or appendRemainingComponent(). */ public void setRemainingName (Name name) { remainingName = name; } /** * Adds the given Name to the remainingName field. * Does nothing when name is null or when a * InvalidNameException is thrown when adding the name. * * @see Name#addAll(Name) */ public void appendRemainingName (Name name) { if (name != null) try { remainingName.addAll(name); } catch(InvalidNameException ine) { /* ignored */ } } /** * Adds the given String to the remainingName field. * Does nothing when name is null or when a * InvalidNameException is thrown when adding the component. * * @see Name#add(String) */ public void appendRemainingComponent (String name) { if (name != null) try { remainingName.add(name); } catch(InvalidNameException ine) { /* ignored */ } } /** * Gets the message given to the constructor or null if no message was given. * * @see Throwable#getMessage(); */ public String getExplanation() { return getMessage(); } /** * Returns a String representation of this exception and possibly including * the part object that could be resolved if the given flag is set to true. * Always includes the root cause and the remaining name if not null. */ public String toString(boolean objectInfo) { StringBuffer sb = new StringBuffer(super.toString()); Throwable cause = getRootCause(); if (cause != null) { sb.append(" caused by "); sb.append(cause); } Name remaining = getRemainingName(); if (remaining != null) { sb.append(" [remainingName: "); sb.append(remaining); } Object resolved = getResolvedObj(); if (objectInfo && resolved != null) { if (remainingName == null) sb.append(" ["); else sb.append(", "); sb.append("resolvedObj: "); sb.append(resolved); } if ((remaining != null) || (objectInfo && resolved != null)) sb.append(']'); return sb.toString(); } /** * Returns a string representation of this exception. * Calls toString(false). */ public String toString() { return toString(false); } /** * Prints the stacktrace of this exception or of the root cause if not null. */ public void printStackTrace() { Throwable cause = getRootCause(); if (cause != null) cause.printStackTrace(); else super.printStackTrace(); } /** * Prints the stacktrace of this exception or of the root cause if not null * to the given PrintStream. */ public void printStackTrace(PrintStream ps) { Throwable cause = getRootCause(); if (cause != null) cause.printStackTrace(ps); else super.printStackTrace(ps); } /** * Prints the stacktrace of this exception or of the root cause if not null * to the given PrintWriter. */ public void printStackTrace(PrintWriter pw) { Throwable cause = getRootCause(); if (cause != null) cause.printStackTrace(pw); else super.printStackTrace(pw); } }