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

Field Summary

Modifier and Type	Field and Description
private String	encoding The encoding for this input, used for `InputType#FILE` and `InputType#INPUT_STREAM`.
private final File	file
private String	identifier An "identifier" for this input.
private final InputStream	inputStream
private final Reader	reader
private final String	string
private String	stringRepresentation
private final SnuggleInput.InputType	type The "type" of input encapsulated by an instance of this class.
private URI	uri An (optional) URI for this input.

Constructor Summary

Access	Constructor and Description
public	SnuggleInput(final String string)
public	SnuggleInput(final String string, final String identifier)
public	SnuggleInput(final File file)
public	SnuggleInput(final File file, final String identifier)
public	SnuggleInput(final File file, final String identifier, String encoding)
public	SnuggleInput(final InputStream inputStream)
public	SnuggleInput(final InputStream inputStream, final String identifier)
public	SnuggleInput(final InputStream inputStream, final String identifier, final String encoding)
public	SnuggleInput(final Reader reader)
public	SnuggleInput(final Reader reader, final String identifier)
private	SnuggleInput(final SnuggleInput.InputType type, final String string, final File file, final InputStream inputStream, final Reader reader, final String identifier, final String encoding)

Method Summary

Modifier and Type	Method and Description
private String	buildStringRepresentation()
public String	getEncoding()
public File	getFile() Returns the `File` that provided this input if type is `InputType#FILE`, null otherwise.
public String	getIdentifier() Returns the "identifier" for this input.
public InputStream	getInputStream() Returns the `InputStream` that provided this input if type is `InputType#INPUT_STREAM`, null otherwise.
public Reader	getReader() Returns the `Reader` that provided this input if type is `InputType#READER`, null otherwise.
public String	getString() Returns the String that provided this input if type is `InputType#STRING`, null otherwise.
public SnuggleInput.InputType	getType() Returns the "type" of input, represented by an instance of the `InputType` enumeration.
public URI	getURI() Returns an (optional) URI for this input.
public void	setEncoding(String encoding)
public void	setIdentifier(String new identifier, which may be null. identifier) Sets the "identifier" for this input.
public void	setURI(URI URI for this input, which may be null. uri) Sets a URI for this input.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

encoding	back to summary
private String encoding The encoding for this input, used for `InputType#FILE` and `InputType#INPUT_STREAM`. If null, we use the platform default encoding.

file	back to summary
private final File file

identifier	back to summary
private String identifier An "identifier" for this input. This is used when formulating error messages. Clients can use as they require - e.g. as a kind of System ID, URL or File name. This must not be null.

identifier

back to summary

private String identifier

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

This must not be null.

inputStream	back to summary
private final InputStream inputStream

reader	back to summary
private final Reader reader

string	back to summary
private final String string

stringRepresentation	back to summary
private String stringRepresentation

type	back to summary
private final SnuggleInput.InputType type The "type" of input encapsulated by an instance of this class.

uri	back to summary
private URI uri An (optional) URI for this input. If provided, this can be used to help resolve links to other Resources.

Constructor Detail

SnuggleInput	back to summary
public SnuggleInput(final String string)

SnuggleInput	back to summary
public SnuggleInput(final String string, final String identifier)

SnuggleInput	back to summary
public SnuggleInput(final File file)

SnuggleInput	back to summary
public SnuggleInput(final File file, final String identifier)

SnuggleInput	back to summary
public SnuggleInput(final File file, final String identifier, String encoding)

SnuggleInput	back to summary
public SnuggleInput(final InputStream inputStream)

SnuggleInput	back to summary
public SnuggleInput(final InputStream inputStream, final String identifier)

SnuggleInput	back to summary
public SnuggleInput(final InputStream inputStream, final String identifier, final String encoding)

SnuggleInput	back to summary
public SnuggleInput(final Reader reader)

SnuggleInput	back to summary
public SnuggleInput(final Reader reader, final String identifier)

SnuggleInput	back to summary
private SnuggleInput(final SnuggleInput.InputType type, final String string, final File file, final InputStream inputStream, final Reader reader, final String identifier, final String encoding)

Method Detail

buildStringRepresentation	back to summary
private String buildStringRepresentation()

getEncoding	back to summary
public String getEncoding()

getFile	back to summary
public File getFile() Returns the `File` that provided this input if type is `InputType#FILE`, null otherwise.

getIdentifier	back to summary
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.

getInputStream	back to summary
public InputStream getInputStream() Returns the `InputStream` that provided this input if type is `InputType#INPUT_STREAM`, null otherwise.

getReader	back to summary
public Reader getReader() Returns the `Reader` that provided this input if type is `InputType#READER`, null otherwise.

getString	back to summary
public String getString() Returns the String that provided this input if type is `InputType#STRING`, null otherwise.

getType	back to summary
public SnuggleInput.InputType getType() Returns the "type" of input, represented by an instance of the `InputType` enumeration.

getURI	back to summary
public URI getURI() Returns an (optional) URI for this input. If provided, this can be used to help resolve links to other `SnuggleInput`s.

setEncoding	back to summary
public void setEncoding(String encoding)

setIdentifier	back to summary
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:String new identifier, which may be null.

setIdentifier

back to summary

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:String: new identifier, which may be null.

setURI back to summary

setURI	back to summary
public void setURI(URI uri) Sets a URI for this input. If provided, this can be used to help resolve links to other `SnuggleInput`s. Parameters uri:URI URI for this input, which may be null.

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: URI for this input, which may be null.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

uk.ac.ed.ph.snuggletex back to summary

public final Enum SnuggleInput.InputType

Class Inheritance

extends Enum<SnuggleInput.InputType>

java.lang.Object
java.lang.Enum
uk.ac.ed.ph.snuggletex.SnuggleInput.InputType

Enumerates the various types of inputs we support.

Field Summary

Modifier and Type	Field and Description
public static final SnuggleInput.InputType	FILE Input is read from a File using either a specified encoding or the platform default encoding
public static final SnuggleInput.InputType	INPUT_STREAM Input is read from an `InputStream` using either a specified encoding or the platform default encoding
public static final SnuggleInput.InputType	READER Input is read from a `Reader`
public static final SnuggleInput.InputType	STRING Input is read from a String

Constructor Summary

Access	Constructor and Description
private	InputType()

Method Summary

Modifier and Type	Method and Description
public static SnuggleInput.InputType	valueOf(String name)
public static SnuggleInput.InputType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FILE	back to summary
public static final SnuggleInput.InputType FILE Input is read from a File using either a specified encoding or the platform default encoding

INPUT_STREAM	back to summary
public static final SnuggleInput.InputType INPUT_STREAM Input is read from an `InputStream` using either a specified encoding or the platform default encoding

READER	back to summary
public static final SnuggleInput.InputType READER Input is read from a `Reader`

STRING	back to summary
public static final SnuggleInput.InputType STRING Input is read from a String

Constructor Detail

InputType	back to summary
private InputType()

Method Detail

valueOf	back to summary
public static SnuggleInput.InputType valueOf(String name)

values	back to summary
public static SnuggleInput.InputType[] values()

public final Class SnuggleInput

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SnuggleInput.InputType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail