net.covers1624.coffeegrinder.util.resolver

Interface Resolver

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

AbstractPathResolver, FolderResolver, JarResolver, JModResolver

public interface Resolver
extends java.io.Closeable

A Resolver, capable of loading the raw bytes for a given Class or Resource.

Created by covers1624 on 8/4/21.

Method Summary

Modifier and Type	Method and Description
default void	close()
static Resolver	findResolver(java.nio.file.Path path) Finds a resolver for the given file.
net.covers1624.quack.collection.FastStream<java.lang.String>	getAllClasses() Gets all the classes available from this Resolver.
net.covers1624.quack.collection.FastStream<java.lang.String>	getAllResources() Gets all the non-class files available from this Resolver.
default byte[]	getClassBytes(java.lang.String name) Gets the bytes for a given class.
byte[]	getResource(java.lang.String name) Gets the bytes for a given resource.
default boolean	hasClass(java.lang.String name) Checks if this resolver is capable of resolving the given class name.
boolean	hasResource(java.lang.String name) Checks if this resolver is capable of resolving the given resource.

Method Detail

getAllClasses

net.covers1624.quack.collection.FastStream<java.lang.String> getAllClasses()
                                                                    throws java.io.IOException

Gets all the classes available from this Resolver.

Returns:

The classes.

Throws:

java.io.IOException

getAllResources

net.covers1624.quack.collection.FastStream<java.lang.String> getAllResources()
                                                                      throws java.io.IOException

Gets all the non-class files available from this Resolver.

Returns:

The non-class files.

Throws:

java.io.IOException

getClassBytes

default byte[] getClassBytes(java.lang.String name)
                      throws java.io.IOException

Gets the bytes for a given class.

Parameters:

name - The class name.

Returns:

The Class bytes, or literal null if no bytes were found.

Throws:

java.io.IOException - If an error occurred whilst reading a file.

See Also:

getAllClasses()

hasClass

default boolean hasClass(java.lang.String name)

Checks if this resolver is capable of resolving the given class name.

Parameters:

name - The class name.

Returns:

If the resolver can resolve this class.

getResource

byte[] getResource(java.lang.String name)
            throws java.io.IOException

Gets the bytes for a given resource.

Parameters:

name - The name of the input.

Returns:

The bytes of the resource or literal null if no bytes were found.

Throws:

java.io.IOException - If an error occurred whilst reading a file.

See Also:

getAllResources()

hasResource

boolean hasResource(java.lang.String name)

Checks if this resolver is capable of resolving the given resource.

Parameters:

name - The resource name.

Returns:

If the resolver can resolve this class.

close

default void close()
            throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

findResolver

static Resolver findResolver(java.nio.file.Path path)

Finds a resolver for the given file.

Parameters:

path - The file path.

Returns:

The Resolver.

Throws:

java.lang.IllegalArgumentException - Thrown if a resolver was not found for a given type.