Package org.opencms.configuration

Class CmsParameterConfiguration.ParameterReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, 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 Description
      ParameterReader​(java.io.Reader reader)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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, 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 Detail

      • ParameterReader

        public 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