com.viaoa.util

Class OAProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

com.viaoa.util.OAProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class OAProperties
extends Properties
implements Serializable

Subclass of java.util.Properties where all "names" for name/value pairs are case insensitive.
NOTE: All name/value pairs are converted to Strings.

This can be used for working with *.ini files.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bUpperCase
protected String	fileName

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
OAProperties() Creates a new OAProperties.
OAProperties(InputStream in)
OAProperties(String fname) Creates a new OAProperties using the specified file name and loads the file.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	exists(String name) Returns true if property name exists.
Object	get(String name) Retrieve value of a name/value pair where name is case insensitive.
boolean	getBoolean(String name) Returns a property that is converted to a "boolean".
boolean	getBoolean(String name, boolean bDefault) Returns a property that is converted to a "boolean".
String	getFileName() Returns name of file that properties are associated with.
int	getInt(String name) Returns a property that is converted to an "int".
int	getInt(String name, int iDefault) Returns a property that is converted to an "int".
String	getProperty(String name) Retrieve value of a name/value pair where name is case insensitive.
String	getProperty(String name, String defaultValue) Retrieve value of a name/value pair where name is case insensitive.
String	getString(String name) Returns a property value.
String	getString(String name, String strDefault) Returns a property value.
Enumeration	keys()
void	load() Load name/value properties from file.
void	load(InputStream in) Loads name/values from a file.
void	load(String fileName) Converts fileName path to correct system file.separator chars and loads name/value properties.
Object	put(Object key, Object obj) Add/replace a name/value.
void	put(String name, boolean b) Add/replace a name/value.
void	put(String name, int i) Add/replace a name/value.
void	putInt(String name, int i) Add/replace a name/value.
Object	remove(Object key) Remove a name/value.
void	save() Saves name/value properties to file.
void	save(String fileName) Converts fileName path to correct system file.separator chars and saves name/value properties to file.
void	save(String fileName, String title) Converts fileName path to correct system file.separator chars and saves name/value properties to file.
void	setFileName(String fname) Sets name of file that properties are associated with.
Object	setProperty(String name, boolean value)
Object	setProperty(String name, double value)
Object	setProperty(String name, int value)
Object	setProperty(String name, long value)
Object	setProperty(String name, Object value)
Object	setProperty(String name, String value)

Methods inherited from class java.util.Properties

list, list, load, loadFromXML, propertyNames, save, store, 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, keySet, merge, putAll, 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

fileName

protected String fileName

bUpperCase

protected boolean bUpperCase

Constructor Detail

OAProperties

public OAProperties()

Creates a new OAProperties.

OAProperties

public OAProperties(String fname)

Creates a new OAProperties using the specified file name and loads the file.

See Also:

load()

OAProperties

public OAProperties(InputStream in)

Method Detail

setFileName

public void setFileName(String fname)

Sets name of file that properties are associated with.

See Also:

load(), save()

getFileName

public String getFileName()

Returns name of file that properties are associated with.

load

public void load()

Load name/value properties from file.

Throws:

IllegalArgumentException - if fileName has not been set.

See Also:

setFileName(java.lang.String)

load

public void load(String fileName)

Converts fileName path to correct system file.separator chars and loads name/value properties.

load

public void load(InputStream in)

Loads name/values from a file. NOTE: if value has spaces after it on the line, they will be included in the value of the property.

Overrides:

load in class Properties

save

public void save()

Saves name/value properties to file.

Throws:

IllegalArgumentException - if fileName has not been set.

See Also:

setFileName(java.lang.String), save(String,String)

save

public void save(String fileName)

Converts fileName path to correct system file.separator chars and saves name/value properties to file. see #ssave(String,String)

save

public void save(String fileName,
                 String title)

Converts fileName path to correct system file.separator chars and saves name/value properties to file.

Parameters:

fileName - name of file to store name/values.

title - is commented title used within file.

getProperty

public String getProperty(String name)

Retrieve value of a name/value pair where name is case insensitive.

Overrides:

getProperty in class Properties

Parameters:

name - is not case sensitive

getProperty

public String getProperty(String name,
                          String defaultValue)

Retrieve value of a name/value pair where name is case insensitive. If property does not exists, then a default value can be specified to use.

Overrides:

getProperty in class Properties

Parameters:

name - is name of property and is not case sensitive.

defaultValue - is returned if property does not exist.

get

public Object get(String name)

Retrieve value of a name/value pair where name is case insensitive.

Parameters:

name - is name of property and is not case sensitive.

setProperty

public Object setProperty(String name,
                          String value)

Overrides:

setProperty in class Properties

setProperty

public Object setProperty(String name,
                          boolean value)

setProperty

public Object setProperty(String name,
                          int value)

setProperty

public Object setProperty(String name,
                          long value)

setProperty

public Object setProperty(String name,
                          double value)

setProperty

public Object setProperty(String name,
                          Object value)

keys

public Enumeration keys()

Overrides:

keys in class Hashtable<Object,Object>

clear

public void clear()

Specified by:

clear in interface Map<Object,Object>

Overrides:

clear in class Hashtable<Object,Object>

put

public Object put(Object key,
                  Object obj)

Add/replace a name/value. param name is name of property and is not case sensitive.

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Hashtable<Object,Object>

remove

public Object remove(Object key)

Remove a name/value. param name is name of property and is not case sensitive.

Specified by:

remove in interface Map<Object,Object>

Overrides:

remove in class Hashtable<Object,Object>

put

public void put(String name,
                int i)

Add/replace a name/value.

Parameters:

name - is name of property and is not case sensitive. see #put(String,Object)

put

public void put(String name,
                boolean b)

Add/replace a name/value.

Parameters:

name - is name of property and is not case sensitive. see #put(String,Object)

putInt

public void putInt(String name,
                   int i)

Add/replace a name/value.

Parameters:

name - is name of property and is not case sensitive. see #put(String,Object)

getInt

public int getInt(String name)

Returns a property that is converted to an "int". If name/value does not exist, or not a number, then -1 is returned.

Parameters:

name - is name of property and is not case sensitive.

getInt

public int getInt(String name,
                  int iDefault)

Returns a property that is converted to an "int". If name/value does not exist, then iDefault is returned. if value is not a number, then -1 is returned.

Parameters:

name - is name of property and is not case sensitive.

getString

public String getString(String name)

Returns a property value. If property does not exist, then null is returned.

Parameters:

name - is name of property and is not case sensitive.

getString

public String getString(String name,
                        String strDefault)

Returns a property value. If property does not exist, then null is returned.

Parameters:

name - is name of property and is not case sensitive.

getBoolean

public boolean getBoolean(String name)

Returns a property that is converted to a "boolean". If name/value does not exist, then false is returned.

Parameters:

name - is name of property and is not case sensitive.

getBoolean

public boolean getBoolean(String name,
                          boolean bDefault)

Returns a property that is converted to a "boolean". If name/value does not exist, then false is returned.

Parameters:

name - is name of property and is not case sensitive.

exists

public boolean exists(String name)

Returns true if property name exists.

Parameters:

name - is name of property and is not case sensitive.