001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.api.sendopts;
043:
044: import java.text.MessageFormat;
045: import java.util.ResourceBundle;
046:
047: /** Signals that something is wrong when processing the command line arguments.
048: *
049: * @author Jaroslav Tulach
050: */
051: public final class CommandException extends Exception {
052: private final int exitCode;
053: private final String locMsg;
054:
055: /** Simple constructor for the CommandException to indicate that a
056: * processing error occurred. The provided <code>exitCode</code> represents
057: * the value to be usually send to as a return value to {@link System#exit}.
058: *
059: * @param exitCode the value, should be different than zero
060: */
061: public CommandException(int exitCode) {
062: this ("Error code: " + exitCode, exitCode, null); // NOI18N
063: }
064:
065: /** Creates new exception with a localised message assigned to it.
066: * @param exitCode exit code to report from the exception
067: * @param locMsg localised message
068: */
069: public CommandException(int exitCode, String locMsg) {
070: this ("Error code: " + exitCode, exitCode, locMsg); // NOI18N
071: }
072:
073: /** Creates a new instance of CommandException */
074: CommandException(String msg, int exitCode, String locMsg) {
075: super (msg);
076: this .exitCode = exitCode;
077: this .locMsg = locMsg;
078: }
079:
080: /** Creates a new instance of CommandException */
081: CommandException(String msg, int exitCode) {
082: this (msg, exitCode, null);
083: }
084:
085: /** Returns an exit code for this exception.
086: * @return integer exit code, zero if exited correctly
087: */
088: public int getExitCode() {
089: return exitCode;
090: }
091:
092: /** Localized message describing the problem that is usually printed
093: * to the user.
094: */
095: public String getLocalizedMessage() {
096: if (locMsg != null) {
097: return locMsg;
098: }
099: if (getCause() != null) {
100: return getCause().getLocalizedMessage();
101: }
102: return super.getLocalizedMessage();
103: }
104: }
|