net.minecraftforge.srg2source.util.io

Class FolderSupplier

java.lang.Object

net.minecraftforge.srg2source.util.io.FolderSupplier

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, InputSupplier, OutputSupplier

public class FolderSupplier
extends java.lang.Object
implements InputSupplier, OutputSupplier

Constructor Summary

Constructors

Constructor and Description
FolderSupplier(java.io.File root)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
java.util.List<java.lang.String>	gatherAll(java.lang.String endFilter) Gathers all the names of all the resources with the given ending in their name.
java.io.InputStream	getInput(java.lang.String relPath) Opens an input stream to the specified resource.
java.io.OutputStream	getOutput(java.lang.String relPath) Opens an output stream to the specified resource.
java.lang.String	getRoot(java.lang.String resource) The absolute path of the root entity of the given resource, be it a file or directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderSupplier

public FolderSupplier(java.io.File root)

Method Detail

getOutput

public java.io.OutputStream getOutput(java.lang.String relPath)

Description copied from interface: OutputSupplier

Opens an output stream to the specified resource. The resource will be created if it does not already exist. You are expected to close this stream yourself.

Specified by:

getOutput in interface OutputSupplier

Parameters:

relPath - Reative path seperated with '/' and having no preceding slash.

Returns:

getInput

public java.io.InputStream getInput(java.lang.String relPath)

Description copied from interface: InputSupplier

Opens an input stream to the specified resource. You are expected to close this stream yourself. Returns null if the resource does not exist.

Specified by:

getInput in interface InputSupplier

Parameters:

relPath - Reative path seperated with '/' and having no preceding slash.

Returns:

gatherAll

public java.util.List<java.lang.String> gatherAll(java.lang.String endFilter)

Description copied from interface: InputSupplier

Gathers all the names of all the resources with the given ending in their name. These paths are gaurnateed to be relative. This will never reeturn null, and return an emtpy list instead.

Specified by:

gatherAll in interface InputSupplier

Returns:

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getRoot

public java.lang.String getRoot(java.lang.String resource)

Description copied from interface: InputSupplier

The absolute path of the root entity of the given resource, be it a file or directory. The passed resource may only be useful when there are resources from multiple roots.

Specified by:

getRoot in interface InputSupplier

Returns: