com.webmethods.rtl.tools

Class PrettyProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

com.webmethods.rtl.tools.PrettyProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class PrettyProperties
extends Properties
implements Cloneable

Read/Write properties file while preserving comments and formatting.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PrettyProperties.NameValue

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMMENT_CHAR1
protected static String	COMMENT_CHAR2
protected static boolean	DEBUG
protected static String	DELIMINATOR
protected HashMap<String,Integer>	m_lineInSource
protected ArrayList<String>	m_sourceDataList
protected static String	NEWLINE
protected static String	OS_PROP
protected boolean	specialCharsEscape
protected static String	specialSaveChars
protected static String	UNIXNEWLINE
protected static String	WINDOWS_DETECT
protected static String	WINDOWSNEWLINE

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
PrettyProperties()
PrettyProperties(Properties defaults)

Method Summary

Modifier and Type	Method and Description
void	clear()
static PrettyProperties	copy(Properties src)
protected static boolean	isCommentLine(String line) Determine if the given line is a comment line
void	load(InputStream in) We override the load function so that we read in comment lines and preserve the original order of the items in the properties file
void	load(Reader reader)
protected PrettyProperties.NameValue	parseLine(String line)
Object	put(Object key, Object value)
void	putAll(Map<? extends Object,? extends Object> t)
Object	remove(Object key)
void	save(OutputStream out, String header)
protected String	saveConvert(String theString, boolean escapeSpace)
void	store(Writer writer, String comments)

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, loadFromXML, propertyNames, setProperty, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putIfAbsent, rehash, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object

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

Field Detail

specialCharsEscape

protected boolean specialCharsEscape

DEBUG

protected static boolean DEBUG

OS_PROP

protected static String OS_PROP

WINDOWS_DETECT

protected static String WINDOWS_DETECT

COMMENT_CHAR1

protected static final String COMMENT_CHAR1

See Also:

Constant Field Values

COMMENT_CHAR2

protected static final String COMMENT_CHAR2

See Also:

Constant Field Values

DELIMINATOR

protected static final String DELIMINATOR

See Also:

Constant Field Values

UNIXNEWLINE

protected static final String UNIXNEWLINE

See Also:

Constant Field Values

WINDOWSNEWLINE

protected static final String WINDOWSNEWLINE

See Also:

Constant Field Values

NEWLINE

protected static String NEWLINE

m_sourceDataList

protected ArrayList<String> m_sourceDataList

m_lineInSource

protected HashMap<String,Integer> m_lineInSource

specialSaveChars

protected static final String specialSaveChars

See Also:

Constant Field Values

Constructor Detail

PrettyProperties

public PrettyProperties()

PrettyProperties

public PrettyProperties(Properties defaults)

Method Detail

copy

public static PrettyProperties copy(Properties src)

putAll

public void putAll(Map<? extends Object,? extends Object> t)

Specified by:

putAll in interface Map<Object,Object>

Overrides:

putAll in class Hashtable<Object,Object>

load

public void load(InputStream in)
          throws IOException

We override the load function so that we read in comment lines and preserve the original order of the items in the properties file

Overrides:

load in class Properties

Throws:

IOException

load

public void load(Reader reader)
          throws IOException

Overrides:

load in class Properties

Throws:

IOException

put

public Object put(Object key,
                  Object value)

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Hashtable<Object,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<Object,Object>

Overrides:

remove in class Hashtable<Object,Object>

clear

public void clear()

Specified by:

clear in interface Map<Object,Object>

Overrides:

clear in class Hashtable<Object,Object>

save

public void save(OutputStream out,
                 String header)

Overrides:

save in class Properties

store

public void store(Writer writer,
                  String comments)
           throws IOException

Overrides:

store in class Properties

Throws:

IOException

isCommentLine

protected static boolean isCommentLine(String line)

Determine if the given line is a comment line

parseLine

protected PrettyProperties.NameValue parseLine(String line)

saveConvert

protected String saveConvert(String theString,
                             boolean escapeSpace)