de.jreality.util

Class Input

java.lang.Object

de.jreality.util.Input

public final class Input
extends Object

Abstraction of an input source, whether given as a file on the local file system, a URL, or as a Java resource. Technically an instance covers an InputStream.

Author:

Steffen Weissman TODO: document this.

Constructor Summary

Constructors

Constructor and Description
Input(File file)
Input(String description, InputStream is)
Input(URL url)

Method Summary

Modifier and Type	Method and Description
Input	copy() Get a fresh version of this Input - i.e.
String	getContentAsString()
String	getDescription()
static Input	getInput(File file) factory method for creating an Input.
static Input	getInput(String resourceName) searches for the given resource name as follows: if resourceName contains :// we try to load it as a URL if resourceName is an absolute filename the corresponding Input is created resourceName is searched in the classpath resourceName is searched relative to System.getProperty(SystemProperties.JREALITY_DATA) resourceName is searched relative to the current dir
static Input	getInput(String description, InputStream in) factory method for creating an Input.
static Input	getInput(URL url) factory method for creating an Input.
InputStream	getInputStream()
Reader	getReader() Creates a Reader for this Input
Reader	getReader(String encoding) Creates a Reader for this Input with given encoding.
Input	getRelativeInput(String name) Tries to resolve a Resource relative to this Input.
Input	resolveInput(String name) Tries to create an Input for the given name as follows: if there is a System resource with the given name, this is returned.
File	toFile() returns a File for this Input if possible.
String	toString()
URL	toURL() returns a URL for this Input if possible.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Input

public Input(URL url)
      throws IOException

Throws:

IOException

Input

public Input(File file)
      throws FileNotFoundException

Throws:

FileNotFoundException

Input

public Input(String description,
             InputStream is)

Method Detail

getInputStream

public InputStream getInputStream()

Returns:

the InputStream for this Input

getReader

public Reader getReader()

Creates a Reader for this Input

Returns:

a reader for the covered InputStream

getReader

public Reader getReader(String encoding)
                 throws UnsupportedEncodingException

Creates a Reader for this Input with given encoding.

Parameters:

encoding - the encoding to use for the created Reader

Returns:

a reader for the covered InputStream with the given encoding

Throws:

UnsupportedEncodingException

getRelativeInput

public Input getRelativeInput(String name)
                       throws IOException

Tries to resolve a Resource relative to this Input. This works only for Files and URLs.

Parameters:

name - the relative name for the resource.

Returns:

an Input for the relative resource.

Throws:

IOException - if no such relative resource was found.

resolveInput

public Input resolveInput(String name)
                   throws IOException

Tries to create an Input for the given name as follows:

if there is a System resource with the given name, this is returned. if the given name is absolute, the corresponding Input is returned. if the input can be resolved relative to an underlying file or URL, this Input is returned. Last try is to find the resource relative to the current directory.

Parameters:

name - the name of the resource.

Returns:

an Input for the given name.

Throws:

IOException - if sth. goes wrong.

toFile

public File toFile()
            throws UnsupportedOperationException

returns a File for this Input if possible.

Returns:

the File of this Input.

Throws:

UnsupportedOperationException - if this Input is not from a file.

toURL

public URL toURL()
          throws MalformedURLException

returns a URL for this Input if possible.

Returns:

the URL of this Input.

Throws:

MalformedURLException - if this Input can't be converted to a URL.

getDescription

public String getDescription()

toString

public String toString()

Overrides:

toString in class Object

getInput

public static Input getInput(URL url)
                      throws IOException

factory method for creating an Input.

Parameters:

url - the URL to create the Input for.

Returns:

an Input that covers the given URL.

Throws:

IOException

getInput

public static Input getInput(File file)
                      throws IOException

factory method for creating an Input.

Parameters:

file - the file to create the Input for.

Returns:

an Input that covers the given File.

Throws:

IOException

getInput

public static Input getInput(String description,
                             InputStream in)
                      throws IOException

factory method for creating an Input.

Parameters:

in - the InputStream to create the Input for.

description - a String describing the type of input.

Returns:

an Input that covers the given InputStream.

Throws:

IOException

getInput

public static Input getInput(String resourceName)
                      throws IOException

searches for the given resource name as follows:

if resourceName contains :// we try to load it as a URL if resourceName is an absolute filename the corresponding Input is created resourceName is searched in the classpath resourceName is searched relative to System.getProperty(SystemProperties.JREALITY_DATA) resourceName is searched relative to the current dir