Module net.luis.utils

Package net.luis.utils.resources

Class ExternalResourceLocation

java.lang.Object

net.luis.utils.resources.ResourceLocation

net.luis.utils.resources.ExternalResourceLocation

final class ExternalResourceLocation
extends ResourceLocation

External implementation of ResourceLocation.
This class is used to load resources from the filesystem.

Nested Class Summary

Nested classes/interfaces inherited from class net.luis.utils.resources.ResourceLocation

ResourceLocation.Type

Field Summary

Fields

Modifier and Type	Field	Description
private final File	file	The resource as a file.
private final Path	path	The resource as a path.

Fields inherited from class net.luis.utils.resources.ResourceLocation

TEMP

Constructor Summary

Constructors

Constructor	Description
ExternalResourceLocation(@Nullable String path, @NotNull String name)	Constructs a new external resource location with the given path and name.
ExternalResourceLocation(@NotNull Pair<String,String> pair)	Constructs a new external resource location from the given Pair. The first value of the pair is the path, and the second value is the name of the resource.

Method Summary

Modifier and Type	Method	Description
@NotNull File	asFile()	Constructs a new File from the resource. Resources on the classpath can not be converted into a file.
@NotNull Path	asPath()	Constructs a new Path from the resource. Resources on the classpath cannot be converted into a path.
@NotNull Path	copy()	Copies the resource to the temporary directory. The copied resource will be deleted on program exit.
@NotNull Path	copy(@NotNull Path target)	Copies the resource to the given target path. The copied resource will stay on the filesystem and will not be deleted on program exit. If a temporary copy of the resource is needed use ResourceLocation.copy() instead.
boolean	exists()	Checks if the resource exists.
byte @NotNull []	getBytes()	Reads the content of the resource as a byte array.
@NotNull Stream<String>	getLines()	Reads the content of the resource as a stream of lines.
@NotNull InputStream	getStream()	Creates an input stream to the resource.
@NotNull String	getString()	Reads the content of the resource as a single string.
@NotNull ResourceLocation.Type	getType()	Returns the type of the resource.
protected @NotNull String	modifyPath(@Nullable String path)	Modifies the path of the resource on construction.

Methods inherited from class net.luis.utils.resources.ResourceLocation

equals, external, external, getFile, getPath, getResource, getResource, hashCode, internal, internal, splitPath, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

file

private final File file

The resource as a file.

path

private final Path path

The resource as a path.

Constructor Details

ExternalResourceLocation

ExternalResourceLocation(@NotNull
 @NotNull Pair<String,String> pair)

Constructs a new external resource location from the given Pair.
The first value of the pair is the path, and the second value is the name of the resource.

Parameters:

pair - The pair

Throws:

NullPointerException - If the pair is null

ExternalResourceLocation

ExternalResourceLocation(@Nullable
 @Nullable String path,
 @NotNull
 @NotNull String name)

Constructs a new external resource location with the given path and name.

Parameters:

path - The path of the resource

name - The name of the resource

Throws:

NullPointerException - If the name is null

Method Details

modifyPath

@NotNull
protected @NotNull String modifyPath(@Nullable
 @Nullable String path)

Description copied from class: ResourceLocation

Modifies the path of the resource on construction.

Specified by:

modifyPath in class ResourceLocation

Parameters:

path - The path to modify

Returns:

The modified path

getType

@NotNull
public @NotNull ResourceLocation.Type getType()

Description copied from class: ResourceLocation

Returns the type of the resource.

Specified by:

getType in class ResourceLocation

Returns:

The type

asFile

@NotNull
public @NotNull File asFile()

Description copied from class: ResourceLocation

Constructs a new File from the resource.
Resources on the classpath can not be converted into a file.

Specified by:

asFile in class ResourceLocation

Returns:

The resource as a File

asPath

@NotNull
public @NotNull Path asPath()

Description copied from class: ResourceLocation

Constructs a new Path from the resource.
Resources on the classpath cannot be converted into a path.

Specified by:

asPath in class ResourceLocation

Returns:

The resource as a Path

exists

public boolean exists()

Description copied from class: ResourceLocation

Checks if the resource exists.

Specified by:

exists in class ResourceLocation

Returns:

True if the resource exists, otherwise false

getStream

@NotNull
public @NotNull InputStream getStream()
                               throws IOException

Description copied from class: ResourceLocation

Creates an input stream to the resource.

Specified by:

getStream in class ResourceLocation

Returns:

An input stream

Throws:

IOException - If an I/O error occurs

getBytes

public byte @NotNull [] getBytes()
                          throws IOException

Description copied from class: ResourceLocation

Reads the content of the resource as a byte array.

Specified by:

getBytes in class ResourceLocation

Returns:

The bytes of the resource

Throws:

IOException - If an I/O error occurs

getString

@NotNull
public @NotNull String getString()
                          throws IOException

Description copied from class: ResourceLocation

Reads the content of the resource as a single string.

Specified by:

getString in class ResourceLocation

Returns:

The resource content

Throws:

IOException - If an I/O error occurs

getLines

@NotNull
public @NotNull Stream<String> getLines()
                                 throws IOException

Description copied from class: ResourceLocation

Reads the content of the resource as a stream of lines.

Specified by:

getLines in class ResourceLocation

Returns:

The resource content

Throws:

IOException - If an I/O error occurs

copy

@NotNull
public @NotNull Path copy()
                   throws IOException

Description copied from class: ResourceLocation

Copies the resource to the temporary directory.
The copied resource will be deleted on program exit.

Specified by:

copy in class ResourceLocation

Returns:

The path of the copied resource

Throws:

IOException - If an I/O error occurs

copy

@NotNull
public @NotNull Path copy(@NotNull
 @NotNull Path target)
                   throws IOException

Description copied from class: ResourceLocation

Copies the resource to the given target path.
The copied resource will stay on the filesystem and will not be deleted on program exit.
If a temporary copy of the resource is needed use ResourceLocation.copy() instead.

Specified by:

copy in class ResourceLocation

Parameters:

target - The target path

Returns:

The path of the copied resource

Throws:

IOException - If an I/O error occurs