org.netbeans.spi.project.ui

Interface ProjectProblemsProvider

public interface ProjectProblemsProvider

Provider of project metadata problems. The provider of various project metadata problems like broken reference to source root, broken reference to a library, wrong compiler options, etc. The provider implementation(s) are registered into the project lookup as well as the LookupMerger for them UILookupMergerSupport.createProjectProblemsProviderMerger().

The presence of the ProjectProblemsProvider in the project lookup automatically enable the broken project metadata badge on the project. If the project wants to provide the "Resolve Broken Project" action it needs to add a reference to the "org.netbeans.modules.project.ui.problems.BrokenProjectActionFactory" action with required position, for example using the ActionRefrecne annotation:

 @ActionReferences({
    @ActionReference(
        id=@ActionID(id="org.netbeans.modules.project.ui.problems.BrokenProjectActionFactory",category="Project"),
        position = 2600,
        path = "Projects/org-netbeans-modules-myproject/Actions")
})
 

Since:

1.60

See Also:

ProjectProblemsProviderSupport

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProjectProblemsProvider.ProjectProblem Project metadata problem.
static class	ProjectProblemsProvider.Result Result of the project metadata problem resolution.
static class	ProjectProblemsProvider.Severity The ProjectProblemsProvider.ProjectProblem severity.
static class	ProjectProblemsProvider.Status The ProjectProblemsProvider.ProjectProblem resolution status.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_PROBLEMS Name of the problems property.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener listening on change of project metadata problems.
Collection<? extends ProjectProblemsProvider.ProjectProblem>	getProblems() Returns project metadata problems found by this ProjectProblemsProvider.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener listening on change of project metadata problems.

Field Detail

PROP_PROBLEMS

static final String PROP_PROBLEMS

Name of the problems property.

See Also:

Constant Field Values

Method Detail

addPropertyChangeListener

void addPropertyChangeListener(@NonNull
                               PropertyChangeListener listener)

Adds a PropertyChangeListener listening on change of project metadata problems.

Parameters:

listener - the listener to be added.

removePropertyChangeListener

void removePropertyChangeListener(@NonNull
                                  PropertyChangeListener listener)

Removes a PropertyChangeListener listening on change of project metadata problems.

Parameters:

listener - the listener to be removed.

getProblems

@NonNull
Collection<? extends ProjectProblemsProvider.ProjectProblem> getProblems()

Returns project metadata problems found by this ProjectProblemsProvider.

Returns:

the problems