org.apache.derby.iapi.services.io
Class FormatableProperties

java.lang.Object
  java.util.Dictionary
      java.util.Hashtable
          java.util.Properties
              org.apache.derby.iapi.services.io.FormatableProperties

All Implemented Interfaces:

java.lang.Cloneable, java.io.Externalizable, Formatable, java.util.Map, java.io.Serializable, TypedFormat

public class FormatableProperties

extends java.util.Properties

implements Formatable

A formatable holder for a java.util.Properties. Used to avoid serializing Properties.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class java.util.Hashtable

Field Summary

Fields inherited from class java.util.Properties

defaults

Fields inherited from class java.util.Hashtable

Constructor Summary

FormatableProperties()
Niladic constructor for formatable

FormatableProperties(java.util.Properties defaults)
Creates an empty property list with the specified defaults.

Method Summary

void	clearDefaults() Clear the defaults from this Properties set.
int	getTypeFormatId() Get the formatID which corresponds to this class.
void	readExternal(ArrayInputStream in)
void	readExternal(java.io.ObjectInput in) Read the properties from a stream of stored objects.
void	writeExternal(java.io.ObjectOutput out) Write the properties out.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, propertyNames, save, setProperty, store

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatableProperties

public FormatableProperties()

Niladic constructor for formatable

FormatableProperties

public FormatableProperties(java.util.Properties defaults)

Creates an empty property list with the specified defaults.

Parameters:

defaults - the defaults

Method Detail

clearDefaults

public void clearDefaults()

Clear the defaults from this Properties set. This sets the default field to null and thus breaks any link with the Properties set that was the default.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Write the properties out. Step through the enumeration and write the strings out in UTF.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - write bytes here

Throws:

java.io.IOException - thrown on error

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException

Read the properties from a stream of stored objects.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - read this.

Throws:

java.io.IOException - thrown on error

readExternal

public void readExternal(ArrayInputStream in)
                  throws java.io.IOException

Throws:

java.io.IOException

getTypeFormatId

public int getTypeFormatId()

Get the formatID which corresponds to this class.

Specified by:

getTypeFormatId in interface TypedFormat

Returns:

the formatID of this class