java.lang.Object
- io.github.classgraph.Resource

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<Resource>
```
public abstract class Resource
extends Object
implements Closeable, Comparable<Resource>
```
A classpath or module path resource (i.e. file) that was found in a whitelisted/non-blacklisted package inside a classpath element or module.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected class`	`Resource.InputStreamResourceCloser`	Class for closing the parent `Resource` when an `InputStream` opened on the resource is closed.

Field Summary

Fields
Modifier and Type Field Description

protected ByteBuffer byteBuffer

protected InputStream inputStream

protected long length

Constructor Summary

Constructors
Constructor Description

Resource()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected byte[]`	`byteBufferToByteArray()`
`protected InputStream`	`byteBufferToInputStream()`
`abstract void`	`close()`	Close the underlying InputStream, or release/unmap the underlying ByteBuffer.
`int`	`compareTo(Resource o)`
`boolean`	`equals(Object obj)`
`abstract File`	`getClasspathElementFile()`
`abstract URL`	`getClasspathElementURL()`
`long`	`getLength()`
`abstract ModuleRef`	`getModuleRef()`
`abstract String`	`getPath()`
`abstract String`	`getPathRelativeToClasspathElement()`
`abstract URL`	`getURL()`
`int`	`hashCode()`
`protected byte[]`	`inputStreamToByteArray()`
`protected ByteBuffer`	`inputStreamToByteBuffer()`
`abstract byte[]`	`load()`	Load a classpath resource and return its content as a byte array.
`abstract InputStream`	`open()`	Open an `InputStream` for a classpath resource.
`abstract ByteBuffer`	`read()`	Open a `ByteBuffer` for a classpath resource.
`String`	`toString()`	Return a string representation of the resource's location.
`protected abstract String`	`toStringImpl()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - inputStream
```
protected InputStream inputStream
```
  - byteBuffer
```
protected ByteBuffer byteBuffer
```
  - length
```
protected long length
```
- Constructor Detail
  - Resource
```
public Resource()
```
- Method Detail
  - byteBufferToInputStream
```
protected InputStream byteBufferToInputStream()
```
  - inputStreamToByteBuffer
```
protected ByteBuffer inputStreamToByteBuffer()
                                      throws IOException
```
    Throws:
    
    IOException
  - inputStreamToByteArray
```
protected byte[] inputStreamToByteArray()
                                 throws IOException
```
    Throws:
    
    IOException
  - byteBufferToByteArray
```
protected byte[] byteBufferToByteArray()
```
  - getPath
```
public abstract String getPath()
```
    Returns:
    
    the path of this classpath resource relative to the package root within the classpath element. For example, for a resource path of "BOOT-INF/classes/com/xyz/resource.xml" and a package root of "BOOT-INF/classes/", returns "com/xyz/resource.xml".
  - getPathRelativeToClasspathElement
```
public abstract String getPathRelativeToClasspathElement()
```
    Returns:
    
    the path of this classpath resource within the classpath element. For example, for a resource path of "BOOT-INF/classes/com/xyz/resource.xml", returns "BOOT-INF/classes/com/xyz/resource.xml", even if the package root is "BOOT-INF/classes/".
  - getURL
```
public abstract URL getURL()
```
    Returns:
    
    A URL representing the resource's location. May point to a temporary file that ClassGraph extracted an inner jar or directory to, or downloaded a remote jar to. You may or may not be able to fetch content from the URL.
    
    Throws:
    
    IllegalArgumentException - if a MalformedURLException occurred while trying to construct the URL.
  - getClasspathElementURL
```
public abstract URL getClasspathElementURL()
```
    Returns:
    
    The URL of the classpath element that this class was found within.
  - getClasspathElementFile
```
public abstract File getClasspathElementFile()
```
    Returns:
    
    The File for the classpath element package root dir or jar that this was found within, or null if this Resource was found in a module. (See also getModuleRef().)
  - getModuleRef
```
public abstract ModuleRef getModuleRef()
```
    Returns:
    
    The module in the module path that this Resource was found within, as a ModuleRef, or null if this Resource was found in a directory or jar in the classpath. (See also getClasspathElementFile().)
  - open
```
public abstract InputStream open()
                          throws IOException
```
    Open an InputStream for a classpath resource. Make sure you call close() when you are finished with the InputStream, so that the InputStream is closed.
    
    Returns:
    
    The opened InputStream.
    
    Throws:
    
    IOException - If the InputStream could not be opened.
  - read
```
public abstract ByteBuffer read()
                         throws IOException
```
    Open a ByteBuffer for a classpath resource. Make sure you call close() when you are finished with the ByteBuffer, so that the ByteBuffer is released or unmapped.
    
    Returns:
    
    The allocated or mapped ByteBuffer for the resource file content.
    
    Throws:
    
    IOException - If the resource could not be opened.
  - load
```
public abstract byte[] load()
                     throws IOException
```
    Load a classpath resource and return its content as a byte array. Automatically calls close() after loading the byte array and before returning it, so that the underlying InputStream is closed or the underlying ByteBuffer is released or unmapped.
    
    Returns:
    
    The contents of the resource file.
    
    Throws:
    
    IOException - If the file contents could not be loaded in their entirety.
  - getLength
```
public long getLength()
```
    Returns:
    
    The length of the resource. This only reliably returns a valid value after calling open(), read(), or load(), and for open(), only if the underlying jarfile has length information for corresponding ZipEntry (some jarfiles may not have length information in their zip entries). Returns -1L if the length is unknown.
  - toStringImpl
```
protected abstract String toStringImpl()
```
  - toString
```
public String toString()
```
    Return a string representation of the resource's location.
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(Resource o)
```
    Specified by:
    
    compareTo in interface Comparable<Resource>
  - close
```
public abstract void close()
```
    Close the underlying InputStream, or release/unmap the underlying ByteBuffer.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable

Modifier and Type	Field	Description
`protected ByteBuffer`	`byteBuffer`
`protected InputStream`	`inputStream`
`protected long`	`length`

Class Resource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inputStream

byteBuffer

length

Constructor Detail

Resource

Method Detail

byteBufferToInputStream

inputStreamToByteBuffer

inputStreamToByteArray

byteBufferToByteArray

getPath

getPathRelativeToClasspathElement

getURL

getClasspathElementURL

getClasspathElementFile

getModuleRef

open

read

load

getLength

toStringImpl

toString

hashCode

equals

compareTo

close