ResourceReader (JQuranTree API Documentation)

Class

Use

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jqurantree.core.resource
Class ResourceReader

java.lang.Object
  org.jqurantree.core.resource.ResourceReader

Utility class which supports reading lines of text from an embedded JAR resource.

Constructor Summary
`ResourceReader(java.lang.String resourcePath)` Creates a new resource reader.

Method Summary
`void`	`close()` Closes the resource.
`java.lang.String`	`readLine()` Reads a line of text from the resource.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

public ResourceReader(java.lang.String resourcePath)

Creates a new resource reader.

Parameters:: resourcePath - the full path and name of the resource, e.g. /foo/bar.txt
Throws:: JQuranTreeException - if the resource does not exist

Method Detail

public java.lang.String readLine()

Reads a line of text from the resource.

Returns:: a string containing the contents of the line, not including line break, or null if the end of the resource has been reached.

public void close()

Closes the resource.