org.netbeans.spi.java.classpath

Interface FilteringPathResourceImplementation

All Superinterfaces:

PathResourceImplementation

public interface FilteringPathResourceImplementation
extends PathResourceImplementation

SPI interface for a classpath entry which can include or exclude particular files.

Since:

org.netbeans.api.java/1 1.13

See Also:

"issue #49026"

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_INCLUDES Property name to fire in case FilteringPathResourceImplementation.includes(java.net.URL, java.lang.String) would change.

Fields inherited from interface org.netbeans.spi.java.classpath.PathResourceImplementation

PROP_ROOTS

Method Summary

Modifier and Type	Method and Description
boolean	includes(URL root, String resource) Determines whether a given resource is included in the classpath or not.

Methods inherited from interface org.netbeans.spi.java.classpath.PathResourceImplementation

addPropertyChangeListener, getContent, getRoots, removePropertyChangeListener

Field Detail

PROP_INCLUDES

static final String PROP_INCLUDES

Property name to fire in case FilteringPathResourceImplementation.includes(java.net.URL, java.lang.String) would change. (The old and new value should be left null.)

Special usage note: If multiple FilteringPathResourceImplementations inside a single ClassPathImplementation fire changes in this pseudo-property in succession, all using the same non-null PropertyChangeEvent.setPropagationId(java.lang.Object), ClassPath.PROP_INCLUDES will be fired just once. This can be used to prevent "event storms" from triggering excessive Java source root rescanning.

See Also:

Constant Field Values

Method Detail

includes

boolean includes(URL root,
                 String resource)

Determines whether a given resource is included in the classpath or not.

Parameters:

root - one of the roots given by PathResourceImplementation.getRoots() (else may throw IllegalArgumentException)

resource - a relative resource path within that root; may refer to a file or slash-terminated folder; the empty string refers to the root itself

Returns:

true if included (or, in the case of a folder, at least partially included); false if excluded