org.millscript.millscript
Class Source

java.lang.Object
  org.millscript.millscript.Source

Direct Known Subclasses:

StandardInputSource, URLSource

public abstract class Source
extends java.lang.Object

Abstract class for representing sources of information. Using instances of this instead of using the relevant Java classes aids debugging, as it contains a method to obtain the origin of this source.

Constructor Summary

Source()

Method Summary

abstract java.io.InputStream	getInputStream() Returns an InputStream to read bytes from this source.
abstract java.lang.String	getOrigin() Returns this sources origin.
abstract java.net.URL	getOriginURL() Returns a URL for the sources origin.
java.io.Reader	getReader() Returns a Reader to read characters from this source.

Methods inherited from class java.lang.Object

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

Constructor Detail

Source

public Source()

Method Detail

getInputStream

public abstract java.io.InputStream getInputStream()

Returns an InputStream to read bytes from this source.

Returns:

an InputStream to read bytes from this source.

getOrigin

public abstract java.lang.String getOrigin()

Returns this sources origin.

Returns:

a String containing this origins source

getOriginURL

public abstract java.net.URL getOriginURL()

Returns a URL for the sources origin.

Returns:

a URL for this sources origin.

getReader

public java.io.Reader getReader()

Returns a Reader to read characters from this source. This method assumes UTF8 encoding for the character data.

Returns:

a Reader to read characters from this source.