org.netbeans.spi.java.project.support.ui

Class BrokenReferencesSupport

java.lang.Object

org.netbeans.spi.java.project.support.ui.BrokenReferencesSupport

public class BrokenReferencesSupport
extends Object

Support for managing broken project references. Project freshly checkout from VCS can has broken references of several types: reference to other project, reference to a foreign file, reference to an external source root, reference to a Java Library or reference to a Java Platform. This class has helper methods for detection of these problems and for fixing them.

Typical usage of this class it to check whether the project has some broken references and if it has then providing an action on project's node which allows to correct these configuration problems by showing broken references customizer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BrokenReferencesSupport.LibraryDefiner Service which may be registered to download remote libraries or otherwise define them.
static interface	BrokenReferencesSupport.PlatformUpdatedCallBack Callback called after the project platform has been updated.

Method Summary

Modifier and Type	Method and Description
static ProjectProblemsProvider	createPlatformVersionProblemProvider(AntProjectHelper projectHelper, PropertyEvaluator evaluator, BrokenReferencesSupport.PlatformUpdatedCallBack postPlatformSetHook, String platformType, SpecificationVersion minimalVersion, String platformProperty, String... versionProperties) Creates a ProjectProblemsProvider creating wrong Java platform version problems.
static ProjectProblemsProvider	createPlatformVersionProblemProvider(AntProjectHelper projectHelper, PropertyEvaluator evaluator, BrokenReferencesSupport.PlatformUpdatedCallBack postPlatformSetHook, String platformType, String platformProperty, String... versionProperties) Creates a ProjectProblemsProvider creating wrong Java platform version problems.
static ProjectProblemsProvider	createProfileProblemProvider(AntProjectHelper projectHelper, ReferenceHelper referenceHelper, PropertyEvaluator evaluator, String profileProperty, String... classPathProperties) Creates a ProjectProblemsProvider creating wrong JDK 8 Profile problems.
static ProjectProblemsProvider	createReferenceProblemsProvider(AntProjectHelper projectHelper, ReferenceHelper referenceHelper, PropertyEvaluator evaluator, BrokenReferencesSupport.PlatformUpdatedCallBack platformUpdatedCallBack, String[] properties, String[] platformProperties) Creates a ProjectProblemsProvider creating broken references problems.
static ProjectProblemsProvider	createReferenceProblemsProvider(AntProjectHelper projectHelper, ReferenceHelper referenceHelper, PropertyEvaluator evaluator, String[] properties, String[] platformProperties) Creates a ProjectProblemsProvider creating broken references problems.
static boolean	isBroken(AntProjectHelper projectHelper, ReferenceHelper referenceHelper, String[] properties, String[] platformProperties) Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.isBroken(org.netbeans.api.project.Project)
static void	showAlert() Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.showAlert(org.netbeans.api.project.Project)
static void	showAlert(AntProjectHelper projectHelper, ReferenceHelper referenceHelper, PropertyEvaluator evaluator, String[] properties, String[] platformProperties) Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.showAlert(org.netbeans.api.project.Project)
static void	showCustomizer(AntProjectHelper projectHelper, ReferenceHelper referenceHelper, String[] properties, String[] platformProperties) Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.showCustomizer(org.netbeans.api.project.Project)

Methods inherited from class java.lang.Object

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

Method Detail

isBroken

@Deprecated
public static boolean isBroken(AntProjectHelper projectHelper,
                                           ReferenceHelper referenceHelper,
                                           String[] properties,
                                           String[] platformProperties)

Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.isBroken(org.netbeans.api.project.Project)

Checks whether the project has some broken references or not.

Parameters:

projectHelper - AntProjectHelper associated with the project.

referenceHelper - ReferenceHelper associated with the project.

properties - array of property names which values hold references which may be broken. For example for J2SE project the property names will be: "javac.classpath", "run.classpath", etc.

platformProperties - array of property names which values hold name of the platform(s) used by the project. These platforms will be checked for existence. For example for J2SE project the property name is one and it is "platform.active". The name of the default platform is expected to be "default_platform" and this platform always exists.

Returns:

true if some problem was found and it is necessary to give user a chance to fix them

showCustomizer

@Deprecated
public static void showCustomizer(AntProjectHelper projectHelper,
                                              ReferenceHelper referenceHelper,
                                              String[] properties,
                                              String[] platformProperties)

Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.showCustomizer(org.netbeans.api.project.Project)

Shows UI customizer which gives users chance to fix encountered problems.

Parameters:

projectHelper - AntProjectHelper associated with the project.

referenceHelper - ReferenceHelper associated with the project.

properties - array of property names which values hold references which may be broken. For example for J2SE project the property names will be: "javac.classpath", "run.classpath", etc.

platformProperties - array of property names which values hold name of the platform(s) used by the project. These platforms will be checked for existence. For example for J2SE project the property name is one and it is "platform.active". The name of the default platform is expected to be "default_platform" and this platform always exists.

See Also:

BrokenReferencesSupport.LibraryDefiner

showAlert

@Deprecated
public static void showAlert()

Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.showAlert(org.netbeans.api.project.Project)

Show alert message box informing user that a project has broken references. This method can be safely called from any thread, e.g. during the project opening, and it will take care about showing message box only once for several subsequent calls during a timeout. The alert box has also "show this warning again" check box.

showAlert

@Deprecated
public static void showAlert(@NonNull
                                         AntProjectHelper projectHelper,
                                         @NonNull
                                         ReferenceHelper referenceHelper,
                                         @NonNull
                                         PropertyEvaluator evaluator,
                                         @NonNull
                                         String[] properties,
                                         @NonNull
                                         String[] platformProperties)

Deprecated. Add ProjectProblemsProvider into project lookup, use BrokenReferencesSupport.createReferenceProblemsProvider(org.netbeans.spi.project.support.ant.AntProjectHelper, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.spi.project.support.ant.PropertyEvaluator, java.lang.String[], java.lang.String[]) as default implementation, and use ProjectProblems.showAlert(org.netbeans.api.project.Project)

Show alert message box informing user that a project has broken references. This method can be safely called from any thread, e.g. during the project opening, and it will take care about showing message box only once for several subsequent calls during a timeout. The alert box has also "show this warning again" check box and provides resolve broken references option

Parameters:

projectHelper - the AntProjectHelper used to resolve broken references

referenceHelper - the ReferenceHelper used to resolve broken references

evaluator - the PropertyEvaluator used to resolve broken references

properties - array of property names which values hold references which may be broken. For example for J2SE project the property names will be: "javac.classpath", "run.classpath", etc.

platformProperties - array of property names which values hold name of the platform(s) used by the project. These platforms will be checked for existence. For example for J2SE project the property name is one and it is "platform.active". The name of the default platform is expected to be "default_platform" and this platform always exists.

Since:

1.37

createReferenceProblemsProvider

@NonNull
public static ProjectProblemsProvider createReferenceProblemsProvider(@NonNull
                                                                               AntProjectHelper projectHelper,
                                                                               @NonNull
                                                                               ReferenceHelper referenceHelper,
                                                                               @NonNull
                                                                               PropertyEvaluator evaluator,
                                                                               @NonNull
                                                                               String[] properties,
                                                                               @NonNull
                                                                               String[] platformProperties)

Creates a ProjectProblemsProvider creating broken references problems.

Parameters:

projectHelper - AntProjectHelper associated with the project.

referenceHelper - ReferenceHelper associated with the project.

evaluator - the PropertyEvaluator used to resolve broken references

properties - array of property names which values hold references which may be broken. For example for J2SE project the property names will be: "javac.classpath", "run.classpath", etc.

platformProperties - array of property names which values hold name of the platform(s) used by the project. These platforms will be checked for existence. For example for J2SE project the property name is one and it is "platform.active". The name of the default platform is expected to be "default_platform" and this platform always exists.

Returns:

the ProjectProblemsProvider to be laced into project lookup.

Since:

1.48

See Also:

ProjectProblemsProvider

createReferenceProblemsProvider

@NonNull
public static ProjectProblemsProvider createReferenceProblemsProvider(@NonNull
                                                                               AntProjectHelper projectHelper,
                                                                               @NonNull
                                                                               ReferenceHelper referenceHelper,
                                                                               @NonNull
                                                                               PropertyEvaluator evaluator,
                                                                               @NullAllowed
                                                                               BrokenReferencesSupport.PlatformUpdatedCallBack platformUpdatedCallBack,
                                                                               @NonNull
                                                                               String[] properties,
                                                                               @NonNull
                                                                               String[] platformProperties)

Creates a ProjectProblemsProvider creating broken references problems.

Parameters:

projectHelper - AntProjectHelper associated with the project.

referenceHelper - ReferenceHelper associated with the project.

evaluator - the PropertyEvaluator used to resolve broken references

platformUpdatedCallBack - called by problem resolution after the platform property has changed to a new platform. The project type can do project specific changes like updating project.xml file. The hook is called under ProjectManager.mutex() write access before the project is saved.

properties - array of property names which values hold references which may be broken. For example for J2SE project the property names will be: "javac.classpath", "run.classpath", etc.

platformProperties - array of property names which values hold name of the platform(s) used by the project. These platforms will be checked for existence. For example for J2SE project the property name is one and it is "platform.active". The name of the default platform is expected to be "default_platform" and this platform always exists.

Returns:

the ProjectProblemsProvider to be laced into project lookup.

Since:

1.68

See Also:

ProjectProblemsProvider

createPlatformVersionProblemProvider

@NonNull
public static ProjectProblemsProvider createPlatformVersionProblemProvider(@NonNull
                                                                                    AntProjectHelper projectHelper,
                                                                                    @NonNull
                                                                                    PropertyEvaluator evaluator,
                                                                                    @NullAllowed
                                                                                    BrokenReferencesSupport.PlatformUpdatedCallBack postPlatformSetHook,
                                                                                    @NonNull
                                                                                    String platformType,
                                                                                    @NonNull
                                                                                    String platformProperty,
                                                                                    @NonNull
                                                                                    String... versionProperties)

Creates a ProjectProblemsProvider creating wrong Java platform version problems.

Parameters:

projectHelper - AntProjectHelper associated with the project.

evaluator - the PropertyEvaluator used to resolve broken references

postPlatformSetHook - called by problem resolution after the platform property has changed to a new platform. The project type can do project specific changes like updating project.xml file. The hook is called under ProjectManager.mutex() write access before the project is saved.

platformType - the type of platform, for example j2se

platformProperty - a property holding the active platform id.

versionProperties - array of property names which values hold the source, target level.

Returns:

ProjectProblemsProvider to be laced into project lookup.

Since:

1.48

See Also:

ProjectProblemsProvider

createPlatformVersionProblemProvider

@NonNull
public static ProjectProblemsProvider createPlatformVersionProblemProvider(@NonNull
                                                                                    AntProjectHelper projectHelper,
                                                                                    @NonNull
                                                                                    PropertyEvaluator evaluator,
                                                                                    @NullAllowed
                                                                                    BrokenReferencesSupport.PlatformUpdatedCallBack postPlatformSetHook,
                                                                                    @NonNull
                                                                                    String platformType,
                                                                                    @NonNull
                                                                                    SpecificationVersion minimalVersion,
                                                                                    @NonNull
                                                                                    String platformProperty,
                                                                                    @NonNull
                                                                                    String... versionProperties)

Creates a ProjectProblemsProvider creating wrong Java platform version problems.

Parameters:

projectHelper - AntProjectHelper associated with the project.

evaluator - the PropertyEvaluator used to resolve broken references

postPlatformSetHook - called by problem resolution after the platform property has changed to a new platform. The project type can do project specific changes like updating project.xml file. The hook is called under ProjectManager.mutex() write access before the project is saved.

platformType - the type of platform, for example j2se

minimalVersion - the minimal source level required by the project

platformProperty - a property holding the active platform id.

versionProperties - array of property names which values hold the source, target level.

Returns:

ProjectProblemsProvider to be laced into project lookup.

Since:

1.74

See Also:

ProjectProblemsProvider

createProfileProblemProvider

@NonNull
public static ProjectProblemsProvider createProfileProblemProvider(@NonNull
                                                                            AntProjectHelper projectHelper,
                                                                            @NonNull
                                                                            ReferenceHelper referenceHelper,
                                                                            @NonNull
                                                                            PropertyEvaluator evaluator,
                                                                            @NonNull
                                                                            String profileProperty,
                                                                            @NonNull
                                                                            String... classPathProperties)

Creates a ProjectProblemsProvider creating wrong JDK 8 Profile problems.

Parameters:

projectHelper - AntProjectHelper associated with the project

referenceHelper - ReferenceHelper associated with the project

evaluator - the PropertyEvaluator used to resolve broken references

profileProperty - the property holding the actual project profile

classPathProperties - an array of property names which values hold the classpaths to be checked.

Returns:

ProjectProblemsProvider to be placed into project lookup.

Since:

1.53

See Also:

ProjectProblemsProvider