Package org.apache.commons.configuration
Class PropertiesConfiguration.PropertiesReader
java.lang.Object
java.io.Reader
java.io.BufferedReader
java.io.LineNumberReader
org.apache.commons.configuration.PropertiesConfiguration.PropertiesReader
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
- Enclosing class:
- PropertiesConfiguration
This class is used to read properties lines. These 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.
-
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionPropertiesReader
(Reader reader) Constructor.PropertiesReader
(Reader reader, char listDelimiter) Creates a new instance ofPropertiesReader
and sets the underlying reader and the list delimiter. -
Method Summary
Modifier and TypeMethodDescriptionReturns the comment lines that have been read for the last property.Returns the name of the last read property.Returns the separator that was used for the last read property.Returns the value of the last read property.protected void
initPropertyName
(String name) Sets the name of the current property.protected void
initPropertySeparator
(String value) Sets the separator of the current property.protected void
initPropertyValue
(String value) Sets the value of the current property.boolean
Parses the next property from the input stream and stores the found name and value in internal fields.protected void
parseProperty
(String line) Parses a line read from the properties file.Reads a property 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
-
Constructor Details
-
PropertiesReader
Constructor.- Parameters:
reader
- A Reader.
-
PropertiesReader
Creates a new instance ofPropertiesReader
and sets the underlying reader and the list delimiter.- Parameters:
reader
- the readerlistDelimiter
- the list delimiter character- Since:
- 1.3
-
-
Method Details
-
readProperty
Reads a property line. Returns null if Stream is at EOF. Concatenates lines ending with "\". Skips lines beginning with "#" or "!" and empty lines. The return value is a property definition (<name>
=<value>
)- Returns:
- A string containing a property value or null
- Throws:
IOException
- in case of an I/O error
-
nextProperty
Parses the next property from the input stream and stores the found name and value in internal fields. These fields can be obtained using the provided getter methods. The return value indicates whether EOF was reached (false) or whether further properties are available (true).- Returns:
- a flag if further properties are available
- Throws:
IOException
- if an error occurs- Since:
- 1.3
-
getCommentLines
Returns the comment lines that have been read for the last property.- Returns:
- the comment lines for the last property returned by
readProperty()
- Since:
- 1.3
-
getPropertyName
Returns the name of the last read property. This method can be called afternextProperty()
was invoked and its return value was true.- Returns:
- the name of the last read property
- Since:
- 1.3
-
getPropertyValue
Returns the value of the last read property. This method can be called afternextProperty()
was invoked and its return value was true.- Returns:
- the value of the last read property
- Since:
- 1.3
-
getPropertySeparator
Returns the separator that was used for the last read property. The separator can be stored so that it can later be restored when saving the configuration.- Returns:
- the separator for the last read property
- Since:
- 1.7
-
parseProperty
Parses a line read from the properties file. This method is called for each non-comment line read from the source file. Its task is to split the passed in line into the property key and its value. The results of the parse operation can be stored by calling theinitPropertyXXX()
methods.- Parameters:
line
- the line read from the properties file- Since:
- 1.7
-
initPropertyName
Sets the name of the current property. This method can be called byparseProperty()
for storing the results of the parse operation. It also ensures that the property key is correctly escaped.- Parameters:
name
- the name of the current property- Since:
- 1.7
-
initPropertyValue
Sets the value of the current property. This method can be called byparseProperty()
for storing the results of the parse operation. It also ensures that the property value is correctly escaped.- Parameters:
value
- the value of the current property- Since:
- 1.7
-
initPropertySeparator
Sets the separator of the current property. This method can be called byparseProperty()
. It allows the associated layout object to keep track of the property separators. When saving the configuration the separators can be restored.- Parameters:
value
- the separator used for the current property- Since:
- 1.7
-