org.netbeans.modules.refactoring.api

Class Problem

java.lang.Object

org.netbeans.modules.refactoring.api.Problem

public final class Problem
extends Object

Class used to represent problems encountered when performing various refactoring calls. Problems can be chained (using setNext method) - every problem can point to the following problem.

Constructor Summary

Constructors

Constructor and Description
Problem(boolean fatal, String message) Creates new instance of Problem class.
Problem(boolean fatal, String message, ProblemDetails details) Creates new instance of Problem class.

Method Summary

Modifier and Type	Method and Description
ProblemDetails	getDetails() Getter for ProblemDetails
String	getMessage() Returns textual description of the problem.
Problem	getNext() Returns the following problem (or null if there none).
boolean	isFatal() Indicates whether the problem is fatal.
void	setNext(Problem next) Sets the following problem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Problem

public Problem(boolean fatal,
               @NonNull
               String message)

Creates new instance of Problem class.

Parameters:

fatal - Indicates whether the problem is fatal.

message - Textual description of the problem.

Problem

public Problem(boolean fatal,
               @NonNull
               String message,
               ProblemDetails details)

Creates new instance of Problem class.

Parameters:

fatal - Indicates whether the problem is fatal.

message - Textual description of the problem.

details - Problem details

See Also:

ProblemDetails

Method Detail

isFatal

public boolean isFatal()

Indicates whether the problem is fatal.

Returns:

true if the problem is fatal, otherwise returns false.

getMessage

@NonNull
public String getMessage()

Returns textual description of the problem.

Returns:

Textual description of the problem.

getNext

@CheckForNull
public Problem getNext()

Returns the following problem (or null if there none).

Returns:

The following problem.

setNext

public void setNext(@NonNull
                    Problem next)
             throws IllegalStateException

Sets the following problem. The problem can be set only once - subsequent attempts to call this method will result in IllegalStateException.

Parameters:

next - The following problem.

Throws:

IllegalStateException - subsequent attempts to call this method will result in IllegalStateException.

getDetails

@CheckForNull
public ProblemDetails getDetails()

Getter for ProblemDetails

Returns:

instance of ProblemDetails or null