org.netbeans.spi.project.libraries.support

Class ForwardingLibraryImplementation

java.lang.Object

org.netbeans.spi.project.libraries.support.ForwardingLibraryImplementation

All Implemented Interfaces:

LibraryImplementation, LibraryImplementation2, LibraryImplementation3, NamedLibraryImplementation

public class ForwardingLibraryImplementation
extends Object
implements LibraryImplementation, NamedLibraryImplementation, LibraryImplementation2, LibraryImplementation3

Forwarding LibraryImplementation. When possible the implementation delegates to given LibraryImplementation, in case that the delegate does not support required contract it throws an UnsupportedOperationException.

Since:

1.48

Field Summary

Fields inherited from interface org.netbeans.spi.project.libraries.LibraryImplementation3

PROP_PROPERTIES

Fields inherited from interface org.netbeans.spi.project.libraries.NamedLibraryImplementation

PROP_DISPLAY_NAME

Fields inherited from interface org.netbeans.spi.project.libraries.LibraryImplementation

PROP_CONTENT, PROP_DESCRIPTION, PROP_NAME

Constructor Summary

Constructors

Constructor and Description
ForwardingLibraryImplementation(LibraryImplementation delegate) Creates a new ForwardingLibraryImplementation.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) Adds PropertyChangeListener
protected void	firePropertyChange(String propName, Object oldValue, Object newValue)
List<URL>	getContent(String volumeType) Returns List of resources contained in the given volume.
LibraryImplementation	getDelegate() Returns the delegate.
String	getDescription() Get a description of the library.
String	getDisplayName() Returns the display name if available or null.
String	getLocalizingBundle() Returns the resource name of the bundle which is used for localizing the name and description.
String	getName() Returns name of the library
Map<String,String>	getProperties() Returns library properties
String	getType() Returns type of library, the LibraryTypeProvider creates libraries of given unique type.
List<URI>	getURIContent(String volumeType) Returns List of resources contained in the given volume.
void	removePropertyChangeListener(PropertyChangeListener l) Removes PropertyChangeListener
void	setContent(String volumeType, List<URL> path) Sets content of given volume
void	setDescription(String text) Sets the description of the library, called by LibrariesStorage while reading the library The description is more detailed information about the library.
void	setDisplayName(String displayName) Sets the display name.
void	setLocalizingBundle(String resourceName) Sets the localizing bundle.
void	setName(String name) Sets the name of the library, called by LibrariesStorage while reading the library
void	setProperties(Map<String,String> properties) Sets the library properties
void	setURIContent(String volumeType, List<URI> path) Sets content of given volume

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingLibraryImplementation

public ForwardingLibraryImplementation(@NonNull
                                       LibraryImplementation delegate)

Creates a new ForwardingLibraryImplementation.

Parameters:

delegate - the delegate

Method Detail

getDelegate

@NonNull
public final LibraryImplementation getDelegate()

Returns the delegate.

Returns:

the delegate

firePropertyChange

protected final void firePropertyChange(@NonNull
                                        String propName,
                                        @NullAllowed
                                        Object oldValue,
                                        @NullAllowed
                                        Object newValue)

getType

public String getType()

Description copied from interface: LibraryImplementation

Returns type of library, the LibraryTypeProvider creates libraries of given unique type.

Specified by:

getType in interface LibraryImplementation

Returns:

String unique identifier, never returns null.

getName

public String getName()

Description copied from interface: LibraryImplementation

Returns name of the library

Specified by:

getName in interface LibraryImplementation

Returns:

String unique name of the library, never returns null.

getDescription

public String getDescription()

Description copied from interface: LibraryImplementation

Get a description of the library. The description provides more detailed information about the library.

Specified by:

getDescription in interface LibraryImplementation

Returns:

String the description or null if the description is not available

getLocalizingBundle

public String getLocalizingBundle()

Description copied from interface: LibraryImplementation

Returns the resource name of the bundle which is used for localizing the name and description. The bundle is located using the system ClassLoader.

Specified by:

getLocalizingBundle in interface LibraryImplementation

Returns:

String, the resource name of the bundle. If null in case when the name and description is not localized.

getContent

public List<URL> getContent(String volumeType)
                     throws IllegalArgumentException

Description copied from interface: LibraryImplementation

Returns List of resources contained in the given volume. The returned list is unmodifiable. To change the content of the given volume use setContent method.

Specified by:

getContent in interface LibraryImplementation

Parameters:

volumeType - the type of volume for which the content should be returned.

Returns:

list of resource URLs (never null)

Throws:

IllegalArgumentException - if the library does not support given type of volume

setName

public void setName(String name)

Description copied from interface: LibraryImplementation

Sets the name of the library, called by LibrariesStorage while reading the library

Specified by:

setName in interface LibraryImplementation

Parameters:

name - - the unique name of the library, can't be null.

setDescription

public void setDescription(String text)

Description copied from interface: LibraryImplementation

Sets the description of the library, called by LibrariesStorage while reading the library The description is more detailed information about the library.

Specified by:

setDescription in interface LibraryImplementation

Parameters:

text - - the description of the library, may be null.

setLocalizingBundle

public void setLocalizingBundle(String resourceName)

Description copied from interface: LibraryImplementation

Sets the localizing bundle. The bundle is used for localizing the name and description. The bundle is located using the system ClassLoader. Called by LibrariesStorage while reading the library.

Specified by:

setLocalizingBundle in interface LibraryImplementation

Parameters:

resourceName - of the bundle without extension, may be null.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: LibraryImplementation

Adds PropertyChangeListener

Specified by:

addPropertyChangeListener in interface LibraryImplementation

Parameters:

l - - the PropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Description copied from interface: LibraryImplementation

Removes PropertyChangeListener

Specified by:

removePropertyChangeListener in interface LibraryImplementation

Parameters:

l - - - the PropertyChangeListener

setContent

public void setContent(String volumeType,
                       List<URL> path)
                throws IllegalArgumentException

Description copied from interface: LibraryImplementation

Sets content of given volume

Specified by:

setContent in interface LibraryImplementation

Parameters:

volumeType - the type of volume for which the content should be set

path - the list of resource URLs

Throws:

IllegalArgumentException - if the library does not support given volumeType

setDisplayName

public void setDisplayName(String displayName)

Description copied from interface: NamedLibraryImplementation

Sets the display name.

Specified by:

setDisplayName in interface NamedLibraryImplementation

Parameters:

displayName - the new value of the displayName. If null resets the display name to the value provided by the localizing bundle or the identifying name.

getDisplayName

public String getDisplayName()

Description copied from interface: NamedLibraryImplementation

Returns the display name if available or null.

Specified by:

getDisplayName in interface NamedLibraryImplementation

Returns:

the display name

getURIContent

public List<URI> getURIContent(String volumeType)
                        throws IllegalArgumentException

Description copied from interface: LibraryImplementation2

Returns List of resources contained in the given volume. The returned list is unmodifiable. To change the content of the given volume use setContent method.

Specified by:

getURIContent in interface LibraryImplementation2

Parameters:

volumeType - the type of volume for which the content should be returned.

Returns:

list of resource URIs (never null)

Throws:

IllegalArgumentException - if the library does not support given type of volume

setURIContent

public void setURIContent(String volumeType,
                          List<URI> path)
                   throws IllegalArgumentException

Description copied from interface: LibraryImplementation2

Sets content of given volume

Specified by:

setURIContent in interface LibraryImplementation2

Parameters:

volumeType - the type of volume for which the content should be set

path - the list of resource URIs

Throws:

IllegalArgumentException - if the library does not support given volumeType

getProperties

public Map<String,String> getProperties()

Description copied from interface: LibraryImplementation3

Returns library properties

Specified by:

getProperties in interface LibraryImplementation3

Returns:

the Map containing the properties

setProperties

public void setProperties(Map<String,String> properties)

Description copied from interface: LibraryImplementation3

Sets the library properties

Specified by:

setProperties in interface LibraryImplementation3

Parameters:

properties - the properties to be set