org.netbeans.modules.java.api.common.classpath

Class ClassPathModifierSupport

java.lang.Object

org.netbeans.modules.java.api.common.classpath.ClassPathModifierSupport

public class ClassPathModifierSupport
extends Object

Helper methods for adding/removing items from project classpath.

Since:

org.netbeans.modules.java.api.common/1 1.5

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD
static int	ADD_NO_HEURISTICS
static int	REMOVE

Constructor Summary

Constructors

Constructor and Description
ClassPathModifierSupport()

Method Summary

Modifier and Type	Method and Description
static boolean	handleAntArtifacts(Project project, AntProjectHelper helper, ClassPathSupport cs, PropertyEvaluator eval, ClassPathUiSupport.Callback cpUiSupportCallback, AntArtifact[] artifacts, URI[] artifactElements, String classPathProperty, String projectXMLElementName, int operation) Deprecated. Use ClassPathModifierSupport.handleAntArtifacts(org.netbeans.api.project.Project, org.netbeans.modules.java.api.common.ant.UpdateHelper, org.netbeans.modules.java.api.common.classpath.ClassPathSupport, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.modules.java.api.common.project.ui.ClassPathUiSupport.Callback, org.netbeans.api.project.ant.AntArtifact[], java.net.URI[], java.lang.String, java.lang.String, int)
static boolean	handleAntArtifacts(Project project, UpdateHelper helper, ClassPathSupport cs, PropertyEvaluator eval, ReferenceHelper refHelper, ClassPathUiSupport.Callback cpUiSupportCallback, AntArtifact[] artifacts, URI[] artifactElements, String classPathProperty, String projectXMLElementName, int operation) Adds or removes project's artifact from given classpath.
static boolean	handleLibraries(Project project, AntProjectHelper helper, ClassPathSupport cs, PropertyEvaluator eval, ClassPathUiSupport.Callback cpUiSupportCallback, ReferenceHelper refHelper, Library[] libraries, String classPathProperty, String projectXMLElementName, int operation)
static boolean	handleLibraryClassPathItems(Project project, AntProjectHelper helper, ClassPathSupport cs, List<ClassPathSupport.Item> items, String classPathProperty, String projectXMLElementName, int operation, boolean saveProject)
static boolean	handleRoots(Project project, AntProjectHelper helper, ClassPathSupport cs, PropertyEvaluator eval, ClassPathUiSupport.Callback cpUiSupportCallback, URI[] classPathRoots, String classPathProperty, String projectXMLElementName, int operation) Deprecated. use ClassPathModifierSupport.handleRoots(org.netbeans.api.project.Project, org.netbeans.modules.java.api.common.ant.UpdateHelper, org.netbeans.modules.java.api.common.classpath.ClassPathSupport, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.modules.java.api.common.project.ui.ClassPathUiSupport.Callback, java.net.URI[], java.lang.String, java.lang.String, int)
static boolean	handleRoots(Project project, UpdateHelper helper, ClassPathSupport cs, PropertyEvaluator eval, ReferenceHelper refHelper, ClassPathUiSupport.Callback cpUiSupportCallback, URI[] classPathRoots, String classPathProperty, String projectXMLElementName, int operation) Adds or removes jar files or folders from given classpath.

Methods inherited from class java.lang.Object

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

Field Detail

ADD

public static final int ADD

See Also:

Constant Field Values

ADD_NO_HEURISTICS

public static final int ADD_NO_HEURISTICS

See Also:

Constant Field Values

REMOVE

public static final int REMOVE

See Also:

Constant Field Values

Constructor Detail

ClassPathModifierSupport

public ClassPathModifierSupport()

Method Detail

handleRoots

@Deprecated
public static boolean handleRoots(@NonNull
                                              Project project,
                                              @NonNull
                                              AntProjectHelper helper,
                                              @NonNull
                                              ClassPathSupport cs,
                                              @NonNull
                                              PropertyEvaluator eval,
                                              @NullAllowed
                                              ClassPathUiSupport.Callback cpUiSupportCallback,
                                              @NonNull
                                              URI[] classPathRoots,
                                              @NonNull
                                              String classPathProperty,
                                              @NullAllowed
                                              String projectXMLElementName,
                                              int operation)
                                       throws IOException

Deprecated. use ClassPathModifierSupport.handleRoots(org.netbeans.api.project.Project, org.netbeans.modules.java.api.common.ant.UpdateHelper, org.netbeans.modules.java.api.common.classpath.ClassPathSupport, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.modules.java.api.common.project.ui.ClassPathUiSupport.Callback, java.net.URI[], java.lang.String, java.lang.String, int)

Adds or removes jar files or folders to (from) given classpath.

Throws:

IOException

handleRoots

public static boolean handleRoots(@NonNull
                                  Project project,
                                  @NonNull
                                  UpdateHelper helper,
                                  @NonNull
                                  ClassPathSupport cs,
                                  @NonNull
                                  PropertyEvaluator eval,
                                  @NonNull
                                  ReferenceHelper refHelper,
                                  @NullAllowed
                                  ClassPathUiSupport.Callback cpUiSupportCallback,
                                  @NonNull
                                  URI[] classPathRoots,
                                  @NonNull
                                  String classPathProperty,
                                  @NullAllowed
                                  String projectXMLElementName,
                                  int operation)
                           throws IOException

Adds or removes jar files or folders from given classpath.

Parameters:

project - the project to (from) which classpath the artifacts should be added (removed).

helper - the UpdateHelper

cs - the ClassPathSupport

eval - the PropertyEvaluator

refHelper - the ReferenceHelper

cpUiSupportCallback - the optional ClassPathUiSupport.Callback doing the ClassPathSupport.Item initialization.

classPathRoots - the jar files or folders to be added (removed)

classPathProperty - the classpath property into (from which) the artifacts should be added (removed).

projectXMLElementName - optional project XML element name

operation - to be performed ClassPathModifierSupport.ADD, ClassPathModifierSupport.ADD_NO_HEURISTICS, ClassPathModifierSupport.REMOVE

Returns:

true if classpath was changed

Throws:

IOException - in case of failure

Since:

1.38

handleAntArtifacts

@Deprecated
public static boolean handleAntArtifacts(@NonNull
                                                     Project project,
                                                     @NonNull
                                                     AntProjectHelper helper,
                                                     @NonNull
                                                     ClassPathSupport cs,
                                                     @NonNull
                                                     PropertyEvaluator eval,
                                                     @NullAllowed
                                                     ClassPathUiSupport.Callback cpUiSupportCallback,
                                                     @NonNull
                                                     AntArtifact[] artifacts,
                                                     @NonNull
                                                     URI[] artifactElements,
                                                     @NonNull
                                                     String classPathProperty,
                                                     @NullAllowed
                                                     String projectXMLElementName,
                                                     int operation)
                                              throws IOException,
                                                     UnsupportedOperationException

Deprecated. Use ClassPathModifierSupport.handleAntArtifacts(org.netbeans.api.project.Project, org.netbeans.modules.java.api.common.ant.UpdateHelper, org.netbeans.modules.java.api.common.classpath.ClassPathSupport, org.netbeans.spi.project.support.ant.PropertyEvaluator, org.netbeans.spi.project.support.ant.ReferenceHelper, org.netbeans.modules.java.api.common.project.ui.ClassPathUiSupport.Callback, org.netbeans.api.project.ant.AntArtifact[], java.net.URI[], java.lang.String, java.lang.String, int)

Adds or removes project's artifact to (from) given classpath.

Throws:

IOException

UnsupportedOperationException

handleAntArtifacts

public static boolean handleAntArtifacts(@NonNull
                                         Project project,
                                         @NonNull
                                         UpdateHelper helper,
                                         @NonNull
                                         ClassPathSupport cs,
                                         @NonNull
                                         PropertyEvaluator eval,
                                         @NonNull
                                         ReferenceHelper refHelper,
                                         @NullAllowed
                                         ClassPathUiSupport.Callback cpUiSupportCallback,
                                         @NonNull
                                         AntArtifact[] artifacts,
                                         @NonNull
                                         URI[] artifactElements,
                                         @NonNull
                                         String classPathProperty,
                                         @NullAllowed
                                         String projectXMLElementName,
                                         int operation)
                                  throws IOException,
                                         UnsupportedOperationException

Adds or removes project's artifact from given classpath.

Parameters:

project - the project to (from) which classpath the artifacts should be added (removed).

helper - the UpdateHelper

cs - the ClassPathSupport

eval - the PropertyEvaluator

refHelper - the ReferenceHelper

cpUiSupportCallback - the optional ClassPathUiSupport.Callback doing the ClassPathSupport.Item initialization.

artifacts - the artifacts to be added

artifactElements - the corresponding artifacts elements

classPathProperty - the classpath property into (from which) the artifacts should be added (removed).

projectXMLElementName - optional project XML element name

operation - to be performed ClassPathModifierSupport.ADD, ClassPathModifierSupport.ADD_NO_HEURISTICS, ClassPathModifierSupport.REMOVE

Returns:

true if classpath was changed

Throws:

IOException - in case of failure

UnsupportedOperationException

Since:

1.38

handleLibraries

public static boolean handleLibraries(Project project,
                                      AntProjectHelper helper,
                                      ClassPathSupport cs,
                                      PropertyEvaluator eval,
                                      ClassPathUiSupport.Callback cpUiSupportCallback,
                                      ReferenceHelper refHelper,
                                      Library[] libraries,
                                      String classPathProperty,
                                      String projectXMLElementName,
                                      int operation)
                               throws IOException,
                                      UnsupportedOperationException

Throws:

IOException

UnsupportedOperationException

handleLibraryClassPathItems

public static boolean handleLibraryClassPathItems(Project project,
                                                  AntProjectHelper helper,
                                                  ClassPathSupport cs,
                                                  List<ClassPathSupport.Item> items,
                                                  String classPathProperty,
                                                  String projectXMLElementName,
                                                  int operation,
                                                  boolean saveProject)
                                           throws IOException

Throws:

IOException