org.spongepowered.api.asset

Interface Asset

public interface Asset

Represents an Asset within Sponge that belongs to a Plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET The default Charset that is used for reading Assets.

Method Summary

Modifier and Type	Method and Description
default void	copyToDirectory(Path outputDirectory) Copies this Asset to the specified 'outputDirectory' Path.
default void	copyToDirectory(Path outputDirectory, boolean overwrite) Copies this Asset to the specified 'outputDirectory' Path.
default void	copyToDirectory(Path outputDirectory, boolean overwrite, boolean onlyIfAbsent) Copies this Asset to the specified 'outputDirectory' Path.
default void	copyToFile(Path output) Copies this Asset to the specified 'output' Path.
default void	copyToFile(Path output, boolean overwrite) Copies this Asset to the specified 'output' Path.
default void	copyToFile(Path output, boolean overwrite, boolean onlyIfAbsent) Copies this Asset to the specified 'output' Path.
default String	getFileName() Returns the the last portion of the Asset URL, e.g.
PluginContainer	getOwner() Returns the original Plugin owner of this Asset.
URL	getUrl() Returns the URL to this Asset.
default byte[]	readBytes() Reads this Asset in it's entirety as a byte array and returns the result.
default List<String>	readLines() Reads all lines from the asset and returns the result.
default List<String>	readLines(Charset charset) Reads all lines from the asset and returns the result.
default String	readString() Reads this Asset in it's entirety as a String and returns the result.
default String	readString(Charset charset) Reads this Asset in it's entirety as a String and returns the result.

Field Detail

DEFAULT_CHARSET

static final Charset DEFAULT_CHARSET

The default Charset that is used for reading Assets.

Method Detail

getOwner

PluginContainer getOwner()

Returns the original Plugin owner of this Asset.

Returns:

Original owner of asset

getUrl

URL getUrl()

Returns the URL to this Asset.

Returns:

URL to asset

copyToFile

default void copyToFile(Path output)
                 throws IOException

Copies this Asset to the specified 'output' Path.

Parameters:

output - Path to copy to

Throws:

IOException - If any file exception is thrown

copyToFile

default void copyToFile(Path output,
                        boolean overwrite)
                 throws IOException

Copies this Asset to the specified 'output' Path.

Parameters:

output - Path to copy to

overwrite - If the file should be overwritten if it exists

Throws:

IOException - File exception

copyToFile

default void copyToFile(Path output,
                        boolean overwrite,
                        boolean onlyIfAbsent)
                 throws IOException

Copies this Asset to the specified 'output' Path.

Parameters:

output - Path to copy to

overwrite - If the file should be overwritten if it exists

onlyIfAbsent - If the file should only be copied if absent

Throws:

IOException - File exception

copyToDirectory

default void copyToDirectory(Path outputDirectory)
                      throws IOException

Copies this Asset to the specified 'outputDirectory' Path.

Parameters:

outputDirectory - The directory to copy to

Throws:

IOException - If any file exception is thrown

copyToDirectory

default void copyToDirectory(Path outputDirectory,
                             boolean overwrite)
                      throws IOException

Copies this Asset to the specified 'outputDirectory' Path.

Parameters:

outputDirectory - The directory to copy to

overwrite - If the file should be overwritten if it exists

Throws:

IOException - File exception

copyToDirectory

default void copyToDirectory(Path outputDirectory,
                             boolean overwrite,
                             boolean onlyIfAbsent)
                      throws IOException

Copies this Asset to the specified 'outputDirectory' Path.

Parameters:

outputDirectory - The directory to copy to

overwrite - If the file should be overwritten if it exists

onlyIfAbsent - If the file should only be copied if absent

Throws:

IOException - File exception

getFileName

default String getFileName()

Returns the the last portion of the Asset URL, e.g. the file name.

Returns:

The file name

readString

default String readString()
                   throws IOException

Reads this Asset in it's entirety as a String and returns the result.

Returns:

String representation of Asset

Throws:

IOException - If any file exception is thrown

readString

default String readString(Charset charset)
                   throws IOException

Reads this Asset in it's entirety as a String and returns the result.

Parameters:

charset - The charset to read the asset with

Returns:

String representation of Asset

Throws:

IOException - If any file exception is thrown

readLines

default List<String> readLines()
                        throws IOException

Reads all lines from the asset and returns the result.

Returns:

The lines read from the asset

Throws:

IOException - If any file exception is thrown

readLines

default List<String> readLines(Charset charset)
                        throws IOException

Reads all lines from the asset and returns the result.

Parameters:

charset - The charset to read the asset with

Returns:

An immutable list of the lines read from the asset

Throws:

IOException - If any file exception is thrown

readBytes

default byte[] readBytes()
                  throws IOException

Reads this Asset in it's entirety as a byte array and returns the result.

Returns:

Byte array representation of Asset

Throws:

IOException - If any file exception is thrown