org.netbeans.spi.project.libraries.support

Class LibrariesSupport

java.lang.Object

org.netbeans.spi.project.libraries.support.LibrariesSupport

public final class LibrariesSupport
extends Object

SPI Support class. Provides factory method for creating instance of the default LibraryImplementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LibrariesSupport.ConversionMode Policy for handling content items which cannot be converted into the desired format.

Method Summary

Modifier and Type	Method and Description
static URI	convertFilePathToURI(String path) Properly converts possibly relative file path to URI.
static List<URL>	convertURIsToURLs(List<? extends URI> uris, LibrariesSupport.ConversionMode conversionMode) Converts a list of URIs into a list of URLs.
static String	convertURIToFilePath(URI uri) Properly converts possibly relative URI to file path.
static List<URI>	convertURLsToURIs(List<URL> urls, LibrariesSupport.ConversionMode conversionMode) Converts a list of URLs into a list of URIs.
static LibraryImplementation	createLibraryImplementation(String libraryType, String[] volumeTypes) Creates default LibraryImplementation
static LibraryImplementation3	createLibraryImplementation3(String libraryType, String... volumeTypes) Creates default LibraryImplementation3
static URI	getArchiveFile(URI uri) Returns the URI of the archive file containing the file referred to by a jar-protocol URL.
static URI	getArchiveRoot(URI uri) Returns a URI representing the root of an archive.
static String	getDisplayName(LibraryImplementation impl) Returns LibraryImplementation display name.
static LibraryImplementation	getLibraryImplementation(Library library) Returns the LibraryImplementation for given Library.
static LibraryStorageArea	getLibraryStorageArea(LibraryManager manager) Returns a LibraryStorageArea for given LibraryManager.
static LibraryTypeProvider	getLibraryTypeProvider(String libraryType) Returns registered LibraryTypeProvider for given library type.
static LibraryTypeProvider[]	getLibraryTypeProviders() Returns all registered LibraryTypeProviders.
static String	getLocalizedName(LibraryImplementation impl) Returns a localized (user friendly) name of the LibraryImplementation.
static Map<String,String>	getProperties(LibraryImplementation impl) Returns LibraryImplementation properties.
static List<URI>	getURIContent(LibraryImplementation impl, String volumeType, LibrariesSupport.ConversionMode conversionMode) Returns LibraryImplementation URI content.
static FileObject	resolveLibraryEntryFileObject(URL libraryLocation, URI libraryEntry) Helper method to resolve (possibly relative) library content URI to FileObject.
static URI	resolveLibraryEntryURI(URL libraryLocation, URI libraryEntry) Helper method to resolve (possibly relative) library content URI.
static boolean	setDisplayName(LibraryImplementation impl, String name) Sets LibraryImplementation display name.
static boolean	setProperties(LibraryImplementation impl, Map<String,String> props) Sets LibraryImplementation properties.
static boolean	setURIContent(LibraryImplementation impl, String volumeType, List<URI> path, LibrariesSupport.ConversionMode conversionMode) Sets LibraryImplementation URI content.
static boolean	supportsDisplayName(LibraryImplementation impl) Tests if given LibraryImplementation supports display name.
static boolean	supportsProperties(LibraryImplementation impl) Tests if given LibraryImplementation supports properties.
static boolean	supportsURIContent(LibraryImplementation impl) Tests if given LibraryImplementation supports URI content.

Methods inherited from class java.lang.Object

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

Method Detail

createLibraryImplementation3

@NonNull
public static LibraryImplementation3 createLibraryImplementation3(@NonNull
                                                                           String libraryType,
                                                                           @NonNull
                                                                           String... volumeTypes)

Creates default LibraryImplementation3

Parameters:

libraryType - type of library

volumeTypes - types of supported volumes

Returns:

LibraryImplementation3

Since:

1.39

createLibraryImplementation

public static LibraryImplementation createLibraryImplementation(String libraryType,
                                                                String[] volumeTypes)

Creates default LibraryImplementation

Parameters:

libraryType - type of library

volumeTypes - types of supported volumes

Returns:

LibraryImplementation, never return null

getLibraryTypeProvider

public static LibraryTypeProvider getLibraryTypeProvider(String libraryType)

Returns registered LibraryTypeProvider for given library type. This method is mostly used by LibraryProvider implementators.

Parameters:

libraryType - the type of library for which the provider should be returned.

Returns:

LibraryTypeProvider for given library type or null, if none is registered.

Since:

org.netbeans.modules.project.libraries/1 1.14

getLibraryTypeProviders

public static LibraryTypeProvider[] getLibraryTypeProviders()

Returns all registered LibraryTypeProviders. This method is mostly used by LibraryProvider implementators.

Returns:

an array of LibraryTypeProvider, never returns null.

Since:

org.netbeans.modules.project.libraries/1 1.14

convertFilePathToURI

public static URI convertFilePathToURI(@NonNull
                                       String path)

Properly converts possibly relative file path to URI.

Parameters:

path - file path to convert; can be relative; cannot be null

Returns:

uri

Since:

org.netbeans.modules.project.libraries/1 1.18

convertURIToFilePath

public static String convertURIToFilePath(URI uri)

Properly converts possibly relative URI to file path.

Parameters:

uri - URI convert; can be relative URI; cannot be null

Returns:

file path

Since:

org.netbeans.modules.project.libraries/1 1.18

convertURIsToURLs

@NonNull
public static List<URL> convertURIsToURLs(@NonNull
                                                   List<? extends URI> uris,
                                                   @NonNull
                                                   LibrariesSupport.ConversionMode conversionMode)

Converts a list of URIs into a list of URLs.

Parameters:

uris - the list of URIs to be converted

conversionMode - the Policy for handling content items which cannot be converted into URLs.

Returns:

the list of URLs

Throws:

IllegalArgumentException - for unconvertable entry in LibrariesSupport.ConversionMode.FAIL

Since:

1.48

convertURLsToURIs

@NonNull
public static List<URI> convertURLsToURIs(@NonNull
                                                   List<URL> urls,
                                                   @NonNull
                                                   LibrariesSupport.ConversionMode conversionMode)

Converts a list of URLs into a list of URIs.

Parameters:

urls - the list of URLs to be converted

conversionMode - the Policy for handling content items which cannot be converted into @{link URI}s

Returns:

the list of URIs

Throws:

IllegalArgumentException - for unconvertable entry in LibrariesSupport.ConversionMode.FAIL

Since:

1.48

resolveLibraryEntryFileObject

public static FileObject resolveLibraryEntryFileObject(URL libraryLocation,
                                                       URI libraryEntry)

Helper method to resolve (possibly relative) library content URI to FileObject.

Parameters:

libraryLocation - library location file; can be null for global libraries

libraryEntry - library entry to resolve

Returns:

file object

Since:

org.netbeans.modules.project.libraries/1 1.18

resolveLibraryEntryURI

public static URI resolveLibraryEntryURI(URL libraryLocation,
                                         URI libraryEntry)

Helper method to resolve (possibly relative) library content URI.

Parameters:

libraryLocation - library location file

libraryEntry - relative library entry to resolve

Returns:

absolute URI

Since:

org.netbeans.modules.project.libraries/1 1.18

getArchiveFile

public static URI getArchiveFile(URI uri)

Returns the URI of the archive file containing the file referred to by a jar-protocol URL. Remember that any path within the archive is discarded so you may need to check for non-root entries.

Parameters:

uri - a URI; can be relative URI

Returns:

the embedded archive URI, or null if the URI is not a jar-protocol URI containing !/

Since:

org.netbeans.modules.project.libraries/1 1.18

getArchiveRoot

public static URI getArchiveRoot(URI uri)

Returns a URI representing the root of an archive.

Parameters:

uri - of a ZIP- (or JAR-) format archive file; can be relative

Returns:

the jar-protocol URI of the root of the archive

Since:

org.netbeans.modules.project.libraries/1 1.18

getLibraryStorageArea

@NonNull
public static LibraryStorageArea getLibraryStorageArea(@NonNull
                                                                LibraryManager manager)

Returns a LibraryStorageArea for given LibraryManager.

Parameters:

manager - the LibraryManager to get a LibraryStorageArea for

Returns:

the LibraryStorageArea

Since:

1.48

getLocalizedName

@NonNull
public static String getLocalizedName(@NonNull
                                               LibraryImplementation impl)

Returns a localized (user friendly) name of the LibraryImplementation.

Parameters:

impl - the library to get the localized name for

Returns:

the localized name

Since:

1.48

supportsDisplayName

public static boolean supportsDisplayName(@NonNull
                                          LibraryImplementation impl)

Tests if given LibraryImplementation supports display name.

Parameters:

impl - the LibraryImplementation to be checked

Returns:

true when given LibraryImplementation supports display name

Since:

1.48

getDisplayName

@CheckForNull
public static String getDisplayName(@NonNull
                                                  LibraryImplementation impl)

Returns LibraryImplementation display name.

Parameters:

impl - the LibraryImplementation to return display name for

Returns:

the display name if supported or null

Since:

1.48

setDisplayName

public static boolean setDisplayName(@NonNull
                                     LibraryImplementation impl,
                                     @NullAllowed
                                     String name)

Sets LibraryImplementation display name.

Parameters:

impl - the LibraryImplementation to set the display name to

name - the display name

Returns:

true if given LibraryImplementation support display name

Since:

1.48

supportsProperties

public static boolean supportsProperties(@NonNull
                                         LibraryImplementation impl)

Tests if given LibraryImplementation supports properties.

Parameters:

impl - the LibraryImplementation to be checked

Returns:

true when given LibraryImplementation supports properties

Since:

1.48

getProperties

@NonNull
public static Map<String,String> getProperties(@NonNull
                                                        LibraryImplementation impl)

Returns LibraryImplementation properties.

Parameters:

impl - the LibraryImplementation to return properties for

Returns:

the library properties if supported or null

Since:

1.48

setProperties

public static boolean setProperties(@NonNull
                                    LibraryImplementation impl,
                                    @NonNull
                                    Map<String,String> props)

Sets LibraryImplementation properties.

Parameters:

impl - the LibraryImplementation to set properties to

props - the properties

Returns:

true if given LibraryImplementation support properties

Since:

1.48

supportsURIContent

public static boolean supportsURIContent(@NonNull
                                         LibraryImplementation impl)

Tests if given LibraryImplementation supports URI content.

Parameters:

impl - the LibraryImplementation to be checked

Returns:

true when given LibraryImplementation supports URI content

Since:

1.48

getURIContent

@NonNull
public static List<URI> getURIContent(@NonNull
                                               LibraryImplementation impl,
                                               @NonNull
                                               String volumeType,
                                               @NonNull
                                               LibrariesSupport.ConversionMode conversionMode)

Returns LibraryImplementation URI content.

Parameters:

impl - the LibraryImplementation to return URI content for

volumeType - the volumeType

conversionMode - conversion failure policy in case the library does not support URI content and the library URLs are converted to URIs

Returns:

the library URI content

Throws:

IllegalArgumentException - when unsupported volumeType or for unconvertable entry in LibrariesSupport.ConversionMode.FAIL

Since:

1.48

setURIContent

public static boolean setURIContent(@NonNull
                                    LibraryImplementation impl,
                                    @NonNull
                                    String volumeType,
                                    @NonNull
                                    List<URI> path,
                                    @NonNull
                                    LibrariesSupport.ConversionMode conversionMode)

Sets LibraryImplementation URI content.

Parameters:

impl - the LibraryImplementation to set the URI content to

volumeType - the volumeType

path - the URI content

conversionMode - conversion failure policy in case the library does not support URI content and the path URIs are converted to URLs

Returns:

true if given LibraryImplementation support URI content

Throws:

IllegalArgumentException - when unsupported volumeType or for unconvertable entry in LibrariesSupport.ConversionMode.FAIL

Since:

1.48

getLibraryImplementation

@NonNull
public static LibraryImplementation getLibraryImplementation(@NonNull
                                                                      Library library)

Returns the LibraryImplementation for given Library.

Parameters:

library - the Library to return SPI for.

Returns:

the LibraryImplementation

Since:

1.51