com.bluetrainsoftware.classpathscanner

Class ResourceScanListener.ScanResource

java.lang.Object

com.bluetrainsoftware.classpathscanner.ResourceScanListener.ScanResource

Enclosing interface:

ResourceScanListener

public static class ResourceScanListener.ScanResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
JarEntry	entry The JarEntry if this resource came from a jar
File	file The File if this resource came from a directory
URL	offsetUrl The URL of the offset within the jar URL (null if a plain jar or directory)
String	resourceName The resource's / separated path name within the "url" field.
URL	url The URL of the directory or jar file

Constructor Summary

Constructors

Constructor and Description
ResourceScanListener.ScanResource(URL url, File file, String resourceName)
ResourceScanListener.ScanResource(URL url, JarEntry entry, String resourceName, URL offsetUrl)

Method Summary

Methods

Modifier and Type	Method and Description
URL	getResolvedUrl() Figures out what the fully resolved url of this file is.
URL	newOffset(String offset) Tries to give you a new offset based on this offsetUrl.

Methods inherited from class java.lang.Object

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

Field Detail

url

public final URL url

The URL of the directory or jar file

offsetUrl

public final URL offsetUrl

The URL of the offset within the jar URL (null if a plain jar or directory)

entry

public final JarEntry entry

The JarEntry if this resource came from a jar

file

public final File file

The File if this resource came from a directory

resourceName

public final String resourceName

The resource's / separated path name within the "url" field. e.g. /META-INF/web-fragment.xml or /com/bluetrainsoftware

Constructor Detail

ResourceScanListener.ScanResource

public ResourceScanListener.ScanResource(URL url,
                                 JarEntry entry,
                                 String resourceName,
                                 URL offsetUrl)

ResourceScanListener.ScanResource

public ResourceScanListener.ScanResource(URL url,
                                 File file,
                                 String resourceName)

Method Detail

getResolvedUrl

public URL getResolvedUrl()

Figures out what the fully resolved url of this file is.

Returns:

- fully resolved url

newOffset

public URL newOffset(String offset)

Tries to give you a new offset based on this offsetUrl. This is used when you detect a particular resource and you need to backtrack and get a parent resource as a URL reference.

Parameters:

offset - - the offset you want to add to the offsetUrl

Returns:

the newly combined url