org.netbeans.spi.project.ui

Class ProjectProblemsProvider.ProjectProblem

java.lang.Object

org.netbeans.spi.project.ui.ProjectProblemsProvider.ProjectProblem

Enclosing interface:

ProjectProblemsProvider

public static final class ProjectProblemsProvider.ProjectProblem
extends Object

Project metadata problem. Represents a problem in the project metadata which should be presented to the user and resolved.

Method Summary

Modifier and Type	Method and Description
static ProjectProblemsProvider.ProjectProblem	createError(String displayName, String description) Creates a new unresolvable instance of the ProjectProblemsProvider.ProjectProblem with error ProjectProblemsProvider.Severity.
static ProjectProblemsProvider.ProjectProblem	createError(String displayName, String description, ProjectProblemResolver resolver) Creates a new instance of the ProjectProblemsProvider.ProjectProblem with error ProjectProblemsProvider.Severity.
static ProjectProblemsProvider.ProjectProblem	createWarning(String displayName, String description) Creates a new unresolvable instance of the ProjectProblemsProvider.ProjectProblem with warning ProjectProblemsProvider.Severity.
static ProjectProblemsProvider.ProjectProblem	createWarning(String displayName, String description, ProjectProblemResolver resolver) Creates a new instance of the ProjectProblemsProvider.ProjectProblem with warning ProjectProblemsProvider.Severity.
boolean	equals(Object other)
String	getDescription() Returns the description of the problem.
String	getDisplayName() Returns a display name of the problem.
ProjectProblemsProvider.Severity	getSeverity() Returns a ProjectProblemsProvider.ProjectProblem severity.
int	hashCode()
boolean	isResolvable() Is the problem resolvable?
Future<ProjectProblemsProvider.Result>	resolve() Resolves the problem.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getSeverity

@NonNull
public ProjectProblemsProvider.Severity getSeverity()

Returns a ProjectProblemsProvider.ProjectProblem severity.

Returns:

the ProjectProblemsProvider.Severity

getDisplayName

@NonNull
public String getDisplayName()

Returns a display name of the problem. The display name is presented to the user in the UI.

Returns:

the display name.

getDescription

@NonNull
public String getDescription()

Returns the description of the problem. The description is shown in the project problems details.

Returns:

project problem description.

isResolvable

public boolean isResolvable()

Is the problem resolvable?

Returns:

Since:

1.74

resolve

public Future<ProjectProblemsProvider.Result> resolve()

Resolves the problem. Called by the Event Dispatch Thread. When the resolution needs to be done by a background thread, eg. downloading an archive from repository, the implementation directly returns a Future which is completed by the background thread.

Returns:

the Future holding the problem resolution status.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createError

@NonNull
public static ProjectProblemsProvider.ProjectProblem createError(@NonNull
                                                                          String displayName,
                                                                          @NonNull
                                                                          String description,
                                                                          @NonNull
                                                                          ProjectProblemResolver resolver)

Creates a new instance of the ProjectProblemsProvider.ProjectProblem with error ProjectProblemsProvider.Severity.

Parameters:

displayName - the project problem display name.

description - the project problem description.

resolver - the ProjectProblemResolver to resolve the problem.

Returns:

a new instance of ProjectProblemsProvider.ProjectProblem

createError

@NonNull
public static ProjectProblemsProvider.ProjectProblem createError(@NonNull
                                                                          String displayName,
                                                                          @NonNull
                                                                          String description)

Creates a new unresolvable instance of the ProjectProblemsProvider.ProjectProblem with error ProjectProblemsProvider.Severity.

Parameters:

displayName - the project problem display name.

description - the project problem description.

Returns:

a new instance of ProjectProblemsProvider.ProjectProblem

Since:

1.74

createWarning

@NonNull
public static ProjectProblemsProvider.ProjectProblem createWarning(@NonNull
                                                                            String displayName,
                                                                            @NonNull
                                                                            String description,
                                                                            @NonNull
                                                                            ProjectProblemResolver resolver)

Creates a new instance of the ProjectProblemsProvider.ProjectProblem with warning ProjectProblemsProvider.Severity.

Parameters:

displayName - the project problem display name.

description - the project problem description.

resolver - the ProjectProblemResolver to resolve the problem.

Returns:

a new instance of ProjectProblemsProvider.ProjectProblem

createWarning

@NonNull
public static ProjectProblemsProvider.ProjectProblem createWarning(@NonNull
                                                                            String displayName,
                                                                            @NonNull
                                                                            String description)

Creates a new unresolvable instance of the ProjectProblemsProvider.ProjectProblem with warning ProjectProblemsProvider.Severity.

Parameters:

displayName - the project problem display name.

description - the project problem description.

Returns:

a new instance of ProjectProblemsProvider.ProjectProblem

Since:

1.74