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

java.lang.Object
  org.netbeans.modules.java.api.common.classpath.ClassPathSupport

public final class ClassPathSupport
extends Object

Support for reading/writting classpath like properties.

Since:

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

Nested Class Summary

static interface	ClassPathSupport.Callback Optional callback to customize classpath support behaviour.
static class	ClassPathSupport.Item Item of the classpath.

Field Summary

static String

ENDORSED Classpath for endorsed libraries.

Constructor Summary

ClassPathSupport(PropertyEvaluator evaluator, ReferenceHelper referenceHelper, AntProjectHelper antProjectHelper, UpdateHelper updateHelper, ClassPathSupport.Callback callback)
Creates a new instance of ClassPathSupport

Method Summary

String[]	encodeToStrings(List<ClassPathSupport.Item> classpath) Converts list of classpath items into array of Strings.
String[]	encodeToStrings(List<ClassPathSupport.Item> classpath, String projectXMLElement)
String[]	encodeToStrings(List<ClassPathSupport.Item> classpath, String projectXMLElement, String libraryVolumeType)
static String	getLibraryNameFromReference(String property) Returns library name if given property represents library reference otherwise return null.
String	getLibraryReference(ClassPathSupport.Item item)
String	getLibraryReference(ClassPathSupport.Item item, String volumeType)
static boolean	isVariableBasedReference(String ref)
Iterator<ClassPathSupport.Item>	itemsIterator(String propertyValue) Creates list of Items from given property.
Iterator<ClassPathSupport.Item>	itemsIterator(String propertyValue, String projectXMLElement)
List<ClassPathSupport.Item>	itemsList(String propertyValue)
List<ClassPathSupport.Item>	itemsList(String propertyValue, String projectXMLElement)

Methods inherited from class java.lang.Object

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

Field Detail

ENDORSED

public static final String ENDORSED

Classpath for endorsed libraries. See ClassPath for other classpath types.

Since:

org.netbeans.modules.java.api.common/0 1.11

See Also:

Constant Field Values

Constructor Detail

ClassPathSupport

public ClassPathSupport(PropertyEvaluator evaluator,
                        ReferenceHelper referenceHelper,
                        AntProjectHelper antProjectHelper,
                        UpdateHelper updateHelper,
                        ClassPathSupport.Callback callback)

Creates a new instance of ClassPathSupport

Method Detail

itemsIterator

public Iterator<ClassPathSupport.Item> itemsIterator(String propertyValue)

Creates list of Items from given property.

itemsIterator

public Iterator<ClassPathSupport.Item> itemsIterator(String propertyValue,
                                                     String projectXMLElement)

itemsList

public List<ClassPathSupport.Item> itemsList(String propertyValue)

itemsList

public List<ClassPathSupport.Item> itemsList(String propertyValue,
                                             String projectXMLElement)

encodeToStrings

public String[] encodeToStrings(List<ClassPathSupport.Item> classpath)

Converts list of classpath items into array of Strings. !! This method creates references in the project !! !! This method may update project.xml !!

encodeToStrings

public String[] encodeToStrings(List<ClassPathSupport.Item> classpath,
                                String projectXMLElement)

encodeToStrings

public String[] encodeToStrings(List<ClassPathSupport.Item> classpath,
                                String projectXMLElement,
                                String libraryVolumeType)

Parameters:

classpath -

projectXMLElement -

libraryVolumeType -

Returns:

Since:

1.22

getLibraryReference

public String getLibraryReference(ClassPathSupport.Item item)

getLibraryReference

public String getLibraryReference(ClassPathSupport.Item item,
                                  String volumeType)

Parameters:

item -

volumeType -

Returns:

Since:

1.22

isVariableBasedReference

public static boolean isVariableBasedReference(String ref)

getLibraryNameFromReference

public static String getLibraryNameFromReference(String property)

Returns library name if given property represents library reference otherwise return null.

Parameters:

property - property to test

Returns:

library name or null