Package gaiasky.util.properties

Class CommentedProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

gaiasky.util.properties.CommentedProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class CommentedProperties
extends Properties

The CommentedProperties class is an extension of java.util.Properties to allow retention of comment lines and blank (whitespace only) lines in the properties file.

Written for Java version 1.4

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
Vector<String>	keyData	Use a Vector to keep a copy of lines containing a key, i.e.
Vector<String>	lineData	Use a Vector to keep a copy of lines that are a comment or 'blank'

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor	Description
CommentedProperties()

Method Summary

Modifier and Type	Method	Description
void	add(String keyString, String value)	Add a Property to the end of the CommentedProperties.
void	addLine(String line)	Add a comment or blank line or comment to the end of the CommentedProperties.
CommentedProperties	clone()
void	load(InputStream inStream)	Load properties from the specified InputStream.
void	load(InputStreamReader isr)	Load properties from the specified InputStreamReader.
void	store(OutputStream out, String header)
void	store(OutputStream out, String header, String encoding)	Write the properties to the specified OutputStream.
void	store(OutputStream out, String header, String encoding, Map<String,String> missing)

Methods inherited from class java.util.Properties

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, getProperty, getProperty, hashCode, isEmpty, keys, keySet, list, list, load, loadFromXML, merge, propertyNames, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, save, setProperty, size, store, storeToXML, storeToXML, storeToXML, stringPropertyNames, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

lineData

public Vector<String> lineData

Use a Vector to keep a copy of lines that are a comment or 'blank'

keyData

public Vector<String> keyData

Use a Vector to keep a copy of lines containing a key, i.e. they are a property.

Constructor Details

CommentedProperties

public CommentedProperties()

Method Details

load

public void load(InputStreamReader isr)
          throws IOException

Load properties from the specified InputStreamReader. Overload the load method in Properties so we can keep comment and blank lines.

Parameters:

isr - The InputStreamReader to read.

Throws:

IOException

load

public void load(InputStream inStream)
          throws IOException

Load properties from the specified InputStream. Overload the load method in Properties so we can keep comment and blank lines.

Overrides:

load in class Properties

Parameters:

inStream - The InputStream to read.

Throws:

IOException

store

public void store(OutputStream out,
 String header)
           throws IOException

Overrides:

store in class Properties

Throws:

IOException

store

public void store(OutputStream out,
 String header,
 String encoding,
 Map<String,String> missing)
           throws IOException

Throws:

IOException

store

public void store(OutputStream out,
 String header,
 String encoding)
           throws IOException

Write the properties to the specified OutputStream.

Overloads the store method in Properties so we can put back comment and blank lines.

Parameters:

out - The OutputStream to write to.

header - Ignored, here for compatibility w/ Properties.

encoding - The encoding of the file

Throws:

IOException - If the creation of the writer fails.

add

public void add(String keyString,
 String value)

Add a Property to the end of the CommentedProperties.

Parameters:

keyString - The Property key.

value - The value of this Property.

addLine

public void addLine(String line)

Add a comment or blank line or comment to the end of the CommentedProperties.

Parameters:

line - The string to add to the end, make sure this is a comment or a 'whitespace' line.

clone

public CommentedProperties clone()

Overrides:

clone in class Properties