Package net.neoforged.fml.jarcontents

Interface JarResource

All Known Implementing Classes:

FolderJarContents.FileResource, JarFileContents.JarEntryResource

@NonExtendable
public interface JarResource

A resource found in a JarContents.

NOTE: Instances of this class obtained from JarResourceVisitor should not be copied for use outside the visitor. If you need to hold onto a resource outside the visitor, copy it first using retain().

Method Summary

Modifier and Type	Method	Description
JarResourceAttributes	attributes()	Reads metadata attributes of this resource.
default BufferedReader	bufferedReader()
default BufferedReader	bufferedReader(Charset charset)
InputStream	open()
default byte[]	readAllBytes()
JarResource	retain()	Create a copy of this jar resource reference that can be held onto.

Method Details

open

InputStream open()
          throws IOException

Throws:

IOException

bufferedReader

default BufferedReader bufferedReader()
                               throws IOException

Throws:

IOException

bufferedReader

default BufferedReader bufferedReader(Charset charset)
                               throws IOException

Throws:

IOException

readAllBytes

default byte[] readAllBytes()
                     throws IOException

Throws:

IOException

attributes

JarResourceAttributes attributes()
                          throws IOException

Reads metadata attributes of this resource.

Returns:

The attributes of this resource.

Throws:

IOException - If accessing the attributes fails due to an I/O error.

retain

JarResource retain()

Create a copy of this jar resource reference that can be held onto.

Useful in the context of JarResourceVisitor, where resource objects are reused between visits, and copies must be made to hold onto resources for later use.