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:

java.io.Closeable, java.lang.Readable

Enclosing class:

CmsParameterConfiguration

protected static class CmsParameterConfiguration.ParameterReader
extends java.io.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 and Description
CmsParameterConfiguration.ParameterReader(java.io.Reader reader) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.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, markSupported, ready

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsParameterConfiguration.ParameterReader

public CmsParameterConfiguration.ParameterReader(java.io.Reader reader)

Constructor.

Parameters:

reader - a reader

Method Detail

readParameter

public java.lang.String readParameter()
                               throws java.io.IOException

Reads a parameter line.

Returns:

the parameter line read

Throws:

java.io.IOException - in case of IO errors