Module watamebot

Package net.foxgenesis.util.resource

Class FormattedModuleResource

java.lang.Object

net.foxgenesis.util.resource.ModuleResource

net.foxgenesis.util.resource.FormattedModuleResource

public class FormattedModuleResource
extends ModuleResource

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

Properties to format are specified by using a regular expression:

 \{\{(.*?)}}
 

Author:

Ashley

Constructor Summary

Constructors

Constructor	Description
FormattedModuleResource(@NotNull String module, @NotNull String resource, @NotNull Map<@NotNull String,@NotNull String> mappings)	Create a new ModuleResource that points to a specified resource inside a module.

Method Summary

Modifier and Type	Method	Description
InputStream	openStream()	Open an InputStream to this resource.

Methods inherited from class net.foxgenesis.util.resource.ModuleResource

asProperties, getModule, getResourcePath, readAllLines, readToString, toString, writeToFile

Methods inherited from class java.lang.Object

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

Constructor Details

FormattedModuleResource

public FormattedModuleResource(@NotNull
 @NotNull String module,
 @NotNull
 @NotNull String resource,
 @NotNull
 @NotNull Map<@NotNull String,@NotNull String> mappings)

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

The specified Map will be used to format all data in this resource.

Parameters:

module - - name of the Module containing the resource

resource - - absolute path to the resource

mappings - - a Map containing all the properties to format

Throws:

NullPointerException - If the module name, resource name or mappings are null

Method Details

openStream

public InputStream openStream()
                       throws IOException

Open an InputStream to this resource.

If the specified mappings is empty, this will operate the same as ModuleResource.openStream(). Otherwise, all data in the stream will be read into a string and formatted with the specified mappings.

Overrides:

openStream in class ModuleResource

Returns:

Returns an InputStream of this resource.

Throws:

IOException - If an I/O error occurs