1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * you may not use this file except in compliance with the License. 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * You may obtain a copy of the License at 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage com.android.dx.util; 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 19f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.io.PrintStream; 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.io.PrintWriter; 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Exception which carries around structured context. 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpublic class ExceptionWithContext 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project extends RuntimeException { 2799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project /** {@code non-null;} human-oriented context of the exception */ 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private StringBuffer context; 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Augments the given exception with the given context, and return the 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * result. The result is either the given exception if it was an 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * {@link ExceptionWithContext}, or a newly-constructed exception if it 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * was not. 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 3699409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param ex {@code non-null;} the exception to augment 3799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param str {@code non-null;} context to add 3899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} an appropriate instance 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public static ExceptionWithContext withContext(Throwable ex, String str) { 41f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project ExceptionWithContext ewc; 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (ex instanceof ExceptionWithContext) { 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project ewc = (ExceptionWithContext) ex; 45f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } else { 46f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project ewc = new ExceptionWithContext(ex); 47f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 48f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 49f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project ewc.addContext(str); 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return ewc; 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an instance. 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param message human-oriented message 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public ExceptionWithContext(String message) { 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project this(message, null); 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an instance. 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 6599409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param cause {@code null-ok;} exception that caused this one 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 67f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public ExceptionWithContext(Throwable cause) { 68f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project this(null, cause); 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 72f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an instance. 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param message human-oriented message 7599409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param cause {@code null-ok;} exception that caused this one 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public ExceptionWithContext(String message, Throwable cause) { 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project super((message != null) ? message : 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project (cause != null) ? cause.getMessage() : null, 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project cause); 81f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (cause instanceof ExceptionWithContext) { 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project String ctx = ((ExceptionWithContext) cause).context.toString(); 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project context = new StringBuffer(ctx.length() + 200); 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project context.append(ctx); 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } else { 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project context = new StringBuffer(200); 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void printStackTrace(PrintStream out) { 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project super.printStackTrace(out); 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.println(context); 96f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void printStackTrace(PrintWriter out) { 101f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project super.printStackTrace(out); 102f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.println(context); 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 104f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Adds a line of context to this instance. 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param str {@code non-null;} new context 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void addContext(String str) { 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (str == null) { 112f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throw new NullPointerException("str == null"); 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 114f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project context.append(str); 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (!str.endsWith("\n")) { 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project context.append('\n'); 118f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 119f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 120f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 121f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Gets the context. 123f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 12499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the context 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public String getContext() { 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return context.toString(); 128f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Prints the message and context. 132f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 13399409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param out {@code non-null;} where to print to 134f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 135f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void printContext(PrintStream out) { 136f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.println(getMessage()); 137f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.print(context); 138f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 139f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 140f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 141f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Prints the message and context. 142f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 14399409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param out {@code non-null;} where to print to 144f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 145f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void printContext(PrintWriter out) { 146f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.println(getMessage()); 147f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.print(context); 148f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 149f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 150