Module watamebot

Package net.foxgenesis.util.resource

Class ModuleResource

java.lang.Object

net.foxgenesis.util.resource.ModuleResource

Direct Known Subclasses:

FormattedModuleResource

public class ModuleResource
extends Object

A class that points to a resource inside a module and implements methods to read from it.

Author:

Ashley

Constructor Summary

Constructors

Constructor	Description
ModuleResource(Module module, String resource)	Create a new ModuleResource that points to a specified resource inside a module.
ModuleResource(String moduleName, String resourcePath)	Create a new ModuleResource that points to a specified resource inside a module.

Method Summary

Modifier and Type	Method	Description
Properties	asProperties()	Read this resource as a Properties file.
Module	getModule()	Get the Module containing this resource.
String	getResourcePath()	Get the path to this resource.
InputStream	openStream()	Open an InputStream to this resource.
String[]	readAllLines()	Read all lines from this resource.
String	readToString()	Read all data from this resource into a string.
String	toString()
void	writeToFile(Path path, CopyOption... options)	Copy this resource to the specified path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ModuleResource

public ModuleResource(@Nonnull
 Module module,
 @Nonnull
 String resource)

Create a new ModuleResource that points to a specified resource inside a module.

Parameters:

module - - Module containing the resource

resource - - absolute path to the resource

Throws:

NullPointerException - If the module name or resource name are null

See Also:

• ModuleResource(String, String)

ModuleResource

public ModuleResource(@Nonnull
 String moduleName,
 @Nonnull
 String resourcePath)
               throws NoSuchElementException

Create a new ModuleResource that points to a specified resource inside a module.

Parameters:

moduleName - - name of the Module containing the resource

resourcePath - - absolute path to the resource

Throws:

NullPointerException - If the module name or resource name are null

NoSuchElementException - If the module was not found

See Also:

• ModuleResource(Module, String)

Method Details

openStream

public InputStream openStream()
                       throws IOException

Open an InputStream to this resource.

Returns:

Returns an InputStream of this resource.

Throws:

IOException - If an I/O error occurs

writeToFile

public void writeToFile(@Nonnull
 Path path,
 CopyOption... options)
                 throws IOException

Copy this resource to the specified path.

Parameters:

path - - Path tp copy to

options - - options specifying how the copy should be done

Throws:

IOException - If an I/O error occurs when reading or writing

readToString

public String readToString()
                    throws IOException

Read all data from this resource into a string.

Returns:

All data inside the resource as a string

Throws:

IOException - If an I/O error occurs

readAllLines

public String[] readAllLines()
                      throws IOException

Read all lines from this resource.

Returns:

All data inside the resource as an array of strings

Throws:

IOException - If an I/O error occurs

asProperties

public Properties asProperties()
                        throws IOException

Read this resource as a Properties file.

Returns:

Returns the parsed Properties

Throws:

IOException - If an I/O error occurs

getModule

public Module getModule()

Get the Module containing this resource.

Returns:

The containing Module

getResourcePath

public String getResourcePath()

Get the path to this resource.

Returns:

Returns the absolute path pointing to this resource

toString

public String toString()

Overrides:

toString in class Object