1/* 2 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26package jdk.javadoc.internal.tool; 27 28import jdk.javadoc.internal.tool.Main.Result; 29 30/** 31 * Provides a general mechanism for the javadoc tool to indicate an option 32 * decoding issue. 33 * 34 * <p><b>This is NOT part of any supported API. 35 * If you write code that depends on this, you do so at your own risk. 36 * This code and its internal interfaces are subject to change or 37 * deletion without notice.</b> 38 */ 39 40class OptionException extends Exception { 41 42 private static final long serialVersionUID = 0; 43 44 public final Result result; 45 public final String message; 46 public final Runnable m; 47 48 /** 49 * Constructs an object with a result, runnable and a message 50 * to be printed out by the catcher. The runnable can be invoked 51 * by the catcher to display the usage text. 52 * @param result the exit code 53 * @param method the method to invoke 54 * @param message the detailed message 55 */ 56 public OptionException(Result result, Runnable method, String message) { 57 this.result = result; 58 this.m = method; 59 this.message = message; 60 if (result == null || result.isOK() || method == null || message == null) { 61 throw new AssertionError("result == null || result.isOK() || " + 62 "method == null || message == null"); 63 } 64 } 65 66 /** 67 * Constructs an object with a result and a runnable. 68 * The runnable can be invoked by the catcher to display the usage text. 69 * @param result the exit code 70 * @param method the method to invoke 71 */ 72 public OptionException(Result result, Runnable method) { 73 this.result = result; 74 this.m = method; 75 this.message = null; 76 if (result == null || method == null) { 77 throw new AssertionError("result == null || method == null"); 78 } 79 } 80} 81