uk.ac.ed.ph.snuggletex

Class SnuggleInput

java.lang.Object

uk.ac.ed.ph.snuggletex.SnuggleInput

public final class SnuggleInput
extends Object

Simple container for an input into SnuggleTeX.

Version:

$Revision$

Author:

David McKain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnuggleInput.InputType Enumerates the various types of inputs we support.

Constructor Summary

Constructors

Constructor and Description
SnuggleInput(File file)
SnuggleInput(File file, String identifier)
SnuggleInput(File file, String identifier, String encoding)
SnuggleInput(InputStream inputStream)
SnuggleInput(InputStream inputStream, String identifier)
SnuggleInput(InputStream inputStream, String identifier, String encoding)
SnuggleInput(Reader reader)
SnuggleInput(Reader reader, String identifier)
SnuggleInput(String string)
SnuggleInput(String string, String identifier)

Method Summary

Modifier and Type	Method and Description
String	getEncoding()
File	getFile() Returns the File that provided this input if type is SnuggleInput.InputType.FILE, null otherwise.
String	getIdentifier() Returns the "identifier" for this input.
InputStream	getInputStream() Returns the InputStream that provided this input if type is SnuggleInput.InputType.INPUT_STREAM, null otherwise.
Reader	getReader() Returns the Reader that provided this input if type is SnuggleInput.InputType.READER, null otherwise.
String	getString() Returns the String that provided this input if type is SnuggleInput.InputType.STRING, null otherwise.
SnuggleInput.InputType	getType() Returns the "type" of input, represented by an instance of the SnuggleInput.InputType enumeration.
URI	getURI() Returns an (optional) URI for this input.
void	setEncoding(String encoding)
void	setIdentifier(String identifier) Sets the "identifier" for this input.
void	setURI(URI uri) Sets a URI for this input.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SnuggleInput

public SnuggleInput(String string)

SnuggleInput

public SnuggleInput(String string,
                    String identifier)

SnuggleInput

public SnuggleInput(File file)

SnuggleInput

public SnuggleInput(File file,
                    String identifier)

SnuggleInput

public SnuggleInput(File file,
                    String identifier,
                    String encoding)

SnuggleInput

public SnuggleInput(InputStream inputStream)

SnuggleInput

public SnuggleInput(InputStream inputStream,
                    String identifier)

SnuggleInput

public SnuggleInput(InputStream inputStream,
                    String identifier,
                    String encoding)

SnuggleInput

public SnuggleInput(Reader reader)

SnuggleInput

public SnuggleInput(Reader reader,
                    String identifier)

Method Detail

getType

public SnuggleInput.InputType getType()

Returns the "type" of input, represented by an instance of the SnuggleInput.InputType enumeration.

getIdentifier

public String getIdentifier()

Returns the "identifier" for this input. This is used when formulating error messages. You can use as you require - e.g. as a kind of System ID, URL or File name.

setIdentifier

public void setIdentifier(String identifier)

Sets the "identifier" for this input. This is used when formulating error messages. You can use as you require - e.g. as a kind of System ID, URL or File name.

Parameters:

identifier - new identifier, which may be null.

getURI

public URI getURI()

Returns an (optional) URI for this input. If provided, this can be used to help resolve links to other SnuggleInputs.

setURI

public void setURI(URI uri)

Sets a URI for this input. If provided, this can be used to help resolve links to other SnuggleInputs.

Parameters:

uri - URI for this input, which may be null.

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

getString

public String getString()

Returns the String that provided this input if type is SnuggleInput.InputType.STRING, null otherwise.

getFile

public File getFile()

Returns the File that provided this input if type is SnuggleInput.InputType.FILE, null otherwise.

getInputStream

public InputStream getInputStream()

Returns the InputStream that provided this input if type is SnuggleInput.InputType.INPUT_STREAM, null otherwise.

getReader

public Reader getReader()

Returns the Reader that provided this input if type is SnuggleInput.InputType.READER, null otherwise.

toString

public String toString()

Overrides:

toString in class Object