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-2007 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: /*
043: * RequirementsException.java
044: *
045: * Created on June 24, 2004, 1:50 PM
046: */
047:
048: package org.netbeans.modules.uml.core.requirementsframework;
049:
050: /**
051: * A requirements exception that also keeps track of the specific cause of the
052: * exception.
053: * @author Trey Spiva
054: */
055: public class RequirementsException extends Exception {
056: /** An unknown error has occured. */
057: public static final int RP_E_UNKNOWN = -1;
058:
059: /** User Canceled out of Provider's Source Selection Dialog. */
060: public static final int RP_E_NO_SELECTION = 0;
061:
062: /** Requirement Source has Already Been Added. */
063: public static final int RP_E_DUPLICATESOURCE = 1;
064:
065: /** DOOORS Shared Edit Mode is Not Supported. */
066: public static final int RP_E_SHAREDEDITNOTSUPPORTED = 2;
067:
068: /** Requirement Source Could Not Be Found. */
069: public static final int RP_E_REQUIREMENTSOURCENOTFOUND = 3;
070:
071: /** Requirement Source Could Not Be Found. */
072: public static final int RP_E_REQUIREMENTLIBRARYNOTFOUND = 4;
073:
074: private int m_ExceptionCode = 0;
075:
076: public RequirementsException(String msg) {
077: this (RP_E_UNKNOWN, msg);
078: }
079:
080: /**
081: * Creates a new instance of <code>RequirementsException</code> without
082: * detail message.
083: *
084: * @param error The error code that caused the exception.
085: *
086: * @see #RP_E_NO_SELECTION
087: * @see #RP_E_DUPLICATESOURCE
088: * @see #RP_E_SHAREDEDITNOTSUPPORTED
089: * @see #RP_E_REQUIREMENTSOURCENOTFOUND
090: */
091: public RequirementsException(int error) {
092: this (error, "");
093: }
094:
095: /**
096: * Constructs an instance of <code>RequirementsException</code> with the specified detail message.
097: * @param msg the detail message.
098: *
099: * @param msg The exception message.
100: * @param error The error code that caused the exception.
101: *
102: * @see #RP_E_NO_SELECTION
103: * @see #RP_E_DUPLICATESOURCE
104: * @see #RP_E_SHAREDEDITNOTSUPPORTED
105: * @see #RP_E_REQUIREMENTSOURCENOTFOUND
106: */
107: public RequirementsException(int error, String msg) {
108: super (msg);
109: setExceptionCode(error);
110: }
111:
112: /**
113: * Retrieves the exception error code. The valid exception error code are:
114: *
115: * RP_E_NO_SELECTION
116: * RP_E_DUPLICATESOURCE
117: * RP_E_SHAREDEDITNOTSUPPORTED
118: * RP_E_REQUIREMENTSOURCENOTFOUND
119: *
120: * @return The error code that caused the exception.
121: *
122: * @see #RP_E_NO_SELECTION
123: * @see #RP_E_DUPLICATESOURCE
124: * @see #RP_E_SHAREDEDITNOTSUPPORTED
125: * @see #RP_E_REQUIREMENTSOURCENOTFOUND
126: */
127: public int getExceptionCode() {
128: return m_ExceptionCode;
129: }
130:
131: /**
132: * Retrieves the exception error code. The valid exception error code are:
133: *
134: * RP_E_NO_SELECTION
135: * RP_E_DUPLICATESOURCE
136: * RP_E_SHAREDEDITNOTSUPPORTED
137: * RP_E_REQUIREMENTSOURCENOTFOUND
138: *
139: * @param code The error code that caused the exception.
140: *
141: * @see #RP_E_NO_SELECTION
142: * @see #RP_E_DUPLICATESOURCE
143: * @see #RP_E_SHAREDEDITNOTSUPPORTED
144: * @see #RP_E_REQUIREMENTSOURCENOTFOUND
145: */
146: public void setExceptionCode(int code) {
147: m_ExceptionCode = code;
148: }
149: }
|