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: package org.netbeans.modules.refactoring.api;
042:
043: /** Class used to represent problems encountered when performing
044: * various refactoring calls. Problems can be chained (using setNext method)
045: * - every problem can point to the following problem.
046: *
047: * @author Martin Matula
048: */
049: public final class Problem {
050: private final boolean fatal;
051: private final String message;
052: private Problem next = null;
053: private ProblemDetails details;
054:
055: /** Creates new instance of Problem class.
056: * @param fatal Indicates whether the problem is fatal.
057: * @param message Textual description of the problem.
058: */
059: public Problem(boolean fatal, String message) {
060: this .fatal = fatal;
061: this .message = message;
062: }
063:
064: /** Creates new instance of Problem class.
065: * @param fatal Indicates whether the problem is fatal.
066: * @param message Textual description of the problem.
067: * @param details Problem details
068: * @see ProblemDetails
069: */
070: public Problem(boolean fatal, String message, ProblemDetails details) {
071: this (fatal, message);
072: this .details = details;
073: }
074:
075: /** Indicates whether the problem is fatal.
076: * @return <code>true</code> if the problem is fatal, otherwise returns <code>false</code>.
077: */
078: public boolean isFatal() {
079: return fatal;
080: }
081:
082: /** Returns textual description of the problem.
083: * @return Textual description of the problem.
084: */
085: public String getMessage() {
086: return message;
087: }
088:
089: /** Returns the following problem (or <code>null</code> if there none).
090: * @return The following problem.
091: */
092: public Problem getNext() {
093: return next;
094: }
095:
096: /**
097: * Sets the following problem. The problem can be set only once - subsequent
098: * attempts to call this method will result in IllegalStateException.
099: * @param next The following problem.
100: * @throws java.lang.IllegalStateException subsequent attempts to call this method will result in IllegalStateException.
101: */
102: public void setNext(Problem next) throws IllegalStateException {
103: if (this .next != null) {
104: throw new IllegalStateException(
105: "Cannot change \"next\" property of Problem."); //NOI18N
106: }
107: this .next = next;
108: }
109:
110: /**
111: * Getter for ProblemDetails
112: * @return instance of ProblemDetails or null
113: */
114: public ProblemDetails getDetails() {
115: return details;
116: }
117: }
|