/*
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.javadoc.internal.tool;

import jdk.javadoc.internal.tool.Main.Result;

Provides a general mechanism for the javadoc tool to indicate an option
decoding issue.
This is NOT part of any supported API.
If you write code that depends on this, you do so at your own risk.
This code and its internal interfaces are subject to change or
deletion without notice.
/**
 * Provides a general mechanism for the javadoc tool to indicate an option
 * decoding issue.
 *
 * <p><b>This is NOT part of any supported API.
 * If you write code that depends on this, you do so at your own risk.
 * This code and its internal interfaces are subject to change or
 * deletion without notice.</b>
 */

class OptionException extends Exception {

    private static final long serialVersionUID = 0;

    public final Result result;
    public final String message;
    public final Runnable m;

    
Constructs an object with a result, runnable and a message
to be printed out by the catcher. The runnable can be invoked
by the catcher to display the usage text.
Params:
result – the exit code
method – the method to invoke
message – the detailed message/**
     * Constructs an object with a result, runnable and a message
     * to be printed out by the catcher. The runnable can be invoked
     * by the catcher to display the usage text.
     * @param result the exit code
     * @param method the method to invoke
     * @param message the detailed message
     */
    public OptionException(Result result, Runnable method, String message) {
        this.result = result;
        this.m = method;
        this.message = message;
        if (result == null || result.isOK() || method == null || message == null) {
            throw new AssertionError("result == null || result.isOK() || " +
                    "method == null || message == null");
        }
    }

    
Constructs an object with a result and a runnable.
The runnable can be invoked by the catcher to display the usage text.
Params:
result – the exit code
method – the method to invoke/**
     * Constructs an object with a result and a runnable.
     * The runnable can be invoked by the catcher to display the usage text.
     * @param result the exit code
     * @param method the method to invoke
     */
    public OptionException(Result result, Runnable method) {
        this.result = result;
        this.m = method;
        this.message = null;
        if (result == null || method == null) {
            throw new AssertionError("result == null || method == null");
        }
    }
}