com.klg.jclass.util.io
Class Properties

java.lang.Object
  |
  +--com.klg.jclass.util.io.Properties

All Implemented Interfaces:

Cloneable, Serializable

Direct Known Subclasses:

LoadProperties, OutputProperties

public class Properties

extends Object

implements Serializable, Cloneable

Definitions for load and save properties

See Also:

Serialized Form

Field Summary

static int	ABSOLUTE
static String	CHARSET_ASCII
static String	CHARSET_ISO
static String	CHARSET_UTF_8
static String[]	charsets
static int	DEFAULT_ACCESS Ways to access a file
static String	DEFAULT_CHARSET_NAME
static String[]	fileAccess_i18n_strings
static String[]	fileAccess_strings
static int[]	fileAccess_values
protected boolean	ignoreExternalResourceExceptions If true, don't throw an exception if internal resources (such as data files) are not found or experience io or parsing problems.
static int	RELATIVE_URL
static int	RESOLVING_CLASS
static int	SERVLET
static int	URL

Constructor Summary

Properties()

Method Summary

Object	clone() Implement Cloneable.
int	getDefaultAccess() Return the default access for this Properties object
int	getFileAccessEnumFromString(String accessString, boolean useI18n) Get the file access enum from its string representation.
String	getFileAccessStringFromEnum(int accessValue, boolean useI18n) Get the file access string representation from its enum value.
boolean	ignoreExternalResourceExceptions() Get the property value which determines whether exceptions caused by loading or saving external resources that are referenced within the xml (data files, for example) are reported.
void	setIgnoreExternalResourceExceptions(boolean ignore) Set the property value which determines whether exceptions caused by loading or saving external resources that are referenced within the xml (data files, for example) are reported.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ACCESS

public static final int DEFAULT_ACCESS

Ways to access a file

See Also:

Constant Field Values

ABSOLUTE

public static final int ABSOLUTE

See Also:

Constant Field Values

RESOLVING_CLASS

public static final int RESOLVING_CLASS

See Also:

Constant Field Values

URL

public static final int URL

See Also:

Constant Field Values

RELATIVE_URL

public static final int RELATIVE_URL

See Also:

Constant Field Values

SERVLET

public static final int SERVLET

See Also:

Constant Field Values

fileAccess_values

public static final int[] fileAccess_values

fileAccess_strings

public static final String[] fileAccess_strings

fileAccess_i18n_strings

public static final String[] fileAccess_i18n_strings

DEFAULT_CHARSET_NAME

public static final String DEFAULT_CHARSET_NAME

See Also:

Constant Field Values

CHARSET_ASCII

public static final String CHARSET_ASCII

See Also:

Constant Field Values

CHARSET_ISO

public static final String CHARSET_ISO

See Also:

Constant Field Values

CHARSET_UTF_8

public static final String CHARSET_UTF_8

See Also:

Constant Field Values

charsets

public static final String[] charsets

ignoreExternalResourceExceptions

protected boolean ignoreExternalResourceExceptions

If true, don't throw an exception if internal resources (such as data files) are not found or experience io or parsing problems.

Constructor Detail

Properties

public Properties()

Method Detail

getFileAccessEnumFromString

public int getFileAccessEnumFromString(String accessString,
                                       boolean useI18n)

Get the file access enum from its string representation. Default access is absolute access. May be over-ridden to provide different behaviour for sub-classes.

Parameters:

accessString - The string version of the fileAccess

useI18n - Use the internationalized strings

Returns:

The enum corresponding to the string

getFileAccessStringFromEnum

public String getFileAccessStringFromEnum(int accessValue,
                                          boolean useI18n)

Get the file access string representation from its enum value.

Parameters:

accessValue - The enum version of the fileAccess

useI18n - Use the internationalized strings

Returns:

The String reprsentation of the fileAccess enum

getDefaultAccess

public int getDefaultAccess()

Return the default access for this Properties object

Returns:

The default access type

ignoreExternalResourceExceptions

public boolean ignoreExternalResourceExceptions()

Get the property value which determines whether exceptions caused by loading or saving external resources that are referenced within the xml (data files, for example) are reported. These exceptions can include JCIOException, IOException, ParserConfigurationException and SAXException. By default this property is false.

Returns:

true, if no exceptions caused by loading external resources are to be thrown.

setIgnoreExternalResourceExceptions

public void setIgnoreExternalResourceExceptions(boolean ignore)

Set the property value which determines whether exceptions caused by loading or saving external resources that are referenced within the xml (data files, for example) are reported. These exceptions can include JCIOException, IOException, ParserConfigurationException and SAXException.

Parameters:

ignore - If true, no exceptions resulting from loading external resources will be thrown when an XML file is parsed.

clone

public Object clone()

Implement Cloneable.

Overrides:

clone in class Object