Package org.opencms.configuration

Class CmsParameterConfiguration.ParameterReader

java.lang.Object

java.io.Reader

java.io.BufferedReader

java.io.LineNumberReader

org.opencms.configuration.CmsParameterConfiguration.ParameterReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

Enclosing class:

CmsParameterConfiguration

protected static class CmsParameterConfiguration.ParameterReader
extends LineNumberReader

Used to read parameter lines from a property file.

The lines do not terminate with new-line chars but rather when there is no backslash sign a the end of the line. This is used to concatenate multiple lines for readability in the input file.

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor	Description
ParameterReader(Reader reader)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	readParameter()	Reads a parameter line.

Methods inherited from class java.io.LineNumberReader

getLineNumber, mark, read, read, readLine, reset, setLineNumber, skip

Methods inherited from class java.io.BufferedReader

close, lines, markSupported, ready

Methods inherited from class java.io.Reader

nullReader, read, read, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ParameterReader

public ParameterReader(Reader reader)

Constructor.

Parameters:

reader - a reader

Method Details

readParameter

public String readParameter()
                     throws IOException

Reads a parameter line.

Returns:

the parameter line read

Throws:

IOException - in case of IO errors