cynosurex.io
Class ConfigureObject

java.lang.Object
  cynosurex.io.ConfigureObject

All Implemented Interfaces:

cynosurex.internal.AuthorCommon, cynosurex.internal.CommonInterface, cynosurex.internal.CompanyCommon

public class ConfigureObject
extends java.lang.Object
implements cynosurex.internal.CommonInterface

This object read and write object configuration files

Field Summary

Fields inherited from interface cynosurex.internal.CommonInterface

copyright, copyrightYears, notice, program, version

Fields inherited from interface cynosurex.internal.AuthorCommon

author, copyrightSymbol, noticeMsg, rights

Fields inherited from interface cynosurex.internal.CompanyCommon

company, email, website

Constructor Summary

ConfigureObject(java.lang.String configname)
Constructor.

Method Summary

boolean	contains(java.lang.Object datum) Whether this ConfigureObject contains the datum.
boolean	containsKey(java.lang.Object key) Whether this ConfigureObject contains the key.
java.lang.Object	getData(java.lang.Object key) This method returns the configuration setting that is associated to the key.
boolean	isEmpty() This method determines with this configuration object is empty.
boolean	load() Load the configuration settings from file into this object.
java.lang.Object	putData(java.lang.Object key, java.lang.Object datum) Puts a configuration setting into this object.
boolean	ReadConfig() Deprecated.
java.lang.Object	removeData(java.lang.Object key)
void	save() Saves the configuration object to file.
int	size() Returns the number of configuration settings in this object.
void	WriteConfig() Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigureObject

public ConfigureObject(java.lang.String configname)

Constructor.

Parameters:

configname - The file name of the configuration file.

Method Detail

contains

public boolean contains(java.lang.Object datum)

Whether this ConfigureObject contains the datum.

Parameters:

datum - The datum to search for.

Returns:

true if this ConfigureObject contains the datum.

containsKey

public boolean containsKey(java.lang.Object key)

Whether this ConfigureObject contains the key.

Parameters:

key - The key to search for.

Returns:

true if this ConfigureObject contains the key.

getData

public java.lang.Object getData(java.lang.Object key)

This method returns the configuration setting that is associated to the key.

isEmpty

public boolean isEmpty()

This method determines with this configuration object is empty.

load

public boolean load()

Load the configuration settings from file into this object.

putData

public java.lang.Object putData(java.lang.Object key,
                                java.lang.Object datum)

Puts a configuration setting into this object.

Parameters:

key - The key to associate to the configuration data.

datum - The configuration data.

Returns:

The key.

ReadConfig

public boolean ReadConfig()

Deprecated.

Reads the configuration file.

Returns:

true if configuration file is read successfully. False otherwise.

removeData

public java.lang.Object removeData(java.lang.Object key)

save

public void save()

Saves the configuration object to file.

size

public int size()

Returns the number of configuration settings in this object.

WriteConfig

public void WriteConfig()

Deprecated.

Writes the configuration file.