com.persistit

Class DefaultCoderManager

java.lang.Object

com.persistit.DefaultCoderManager

All Implemented Interfaces:

CoderManager

public final class DefaultCoderManager
extends Object
implements CoderManager

A simple CoderManager implementation that associates each registered Class with its corresponding KeyCoder or ValueCoder. See CoderManager for more information.

This implementation builds a HashMap to associate each registered Class with its KeyCoder or ValueCoder. Registering a class MyClass has no effect on the encoding or decoding of subclasses of MyClass. Each subclass needs to be registered separately, even if the ValueCoder or KeyCoder is the same for each subclass. A custom CoderManager implementation could modify this behavior.

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
DefaultCoderManager(Persistit persistit) Construct a new DefaultCoderManager, using the serialOverride system configuration property to determine which classes, if any, must employ standard Java serialization.
DefaultCoderManager(Persistit persistit, String patterns) Construct a new DefaultCoderManager that uses standard Java serialization for any class whose name conforms to the supplied patterns string.

Method Summary

Modifier and Type	Method and Description
CoderManager	getParent() Returns the parent CoderManager.
Map<Class<?>,KeyCoder>	getRegisteredKeyCoders() Create a Map of Classes to registered KeyCoder s.
Map<Class<?>,ValueCoder>	getRegisteredValueCoders() Create a Map of Classes to registered ValueCoders.
String	getSerialOverridePatterns() Returns the serialization override pattern specified by the serialOverride property.
ValueCoder	getValueCoder(Class<?> clazz) Return a ValueCoder for the supplied Class.
boolean	isSerialOverride(Class<?> clazz) Tests whether the supplied class is included in the serial override set.
KeyCoder	lookupKeyCoder(Class<?> clazz) Returns the KeyCoder registered for the supplied Class, or null if no KeyCoder is registered.
ValueCoder	lookupValueCoder(Class<?> clazz) Return the ValueCoder registered for the supplied Class , or null if no ValueCoder is registered.
KeyCoder	registerKeyCoder(Class<?> clazz, KeyCoder coder) Associates a KeyCoder with a Class that it will encode.
ValueCoder	registerValueCoder(Class<?> clazz, ValueCoder coder) Attempt to register the provided ValueCoder to encode and decode instances of supplied Class.
KeyCoder	unregisterKeyCoder(Class<?> clazz) Removes any KeyCoder registered for the supplied Class
int	unregisterKeyCoder(KeyCoder coder) Unregisters the supplied KeyCoder from all Classes it was previously registered to handle.
ValueCoder	unregisterValueCoder(Class<?> clazz) Removes any ValueCoder registered for the supplied Class
int	unregisterValueCoder(ValueCoder coder) Unregisters the supplied ValueCoder from all Classes it was previously registered to handle.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCoderManager

public DefaultCoderManager(Persistit persistit)

Construct a new DefaultCoderManager, using the serialOverride system configuration property to determine which classes, if any, must employ standard Java serialization.

Parameters:

persistit - the Persistit instance

Throws:

IllegalArgumentException - if the format of the serialOverride property is invalid

DefaultCoderManager

public DefaultCoderManager(Persistit persistit,
                           String patterns)

Construct a new DefaultCoderManager that uses standard Java serialization for any class whose name conforms to the supplied patterns string. See getSerialOverridePatterns() for details.

Parameters:

persistit - the Persistit instance

patterns - Specifies class names of classes that always use standard Java serialization rather a custom ValueCoder implementation.

Throws:

IllegalArgumentException - if the format of the supplied patterns string is invalid

Method Detail

getParent

public CoderManager getParent()

Returns the parent CoderManager.

Specified by:

getParent in interface CoderManager

Returns:

The parent

registerKeyCoder

public KeyCoder registerKeyCoder(Class<?> clazz,
                                 KeyCoder coder)

Associates a KeyCoder with a Class that it will encode.

Specified by:

registerKeyCoder in interface CoderManager

Parameters:

clazz - The Class

coder - The KeyCoder

Returns:

The KeyCoder formerly registered for this Class , or null if there was none.

unregisterKeyCoder

public KeyCoder unregisterKeyCoder(Class<?> clazz)

Removes any KeyCoder registered for the supplied Class

Specified by:

unregisterKeyCoder in interface CoderManager

Parameters:

clazz - The Class that will no longer have a KeyCoder

Returns:

The removed KeyCoder, or null if there was none.

unregisterKeyCoder

public int unregisterKeyCoder(KeyCoder coder)

Unregisters the supplied KeyCoder from all Classes it was previously registered to handle.

Specified by:

unregisterKeyCoder in interface CoderManager

Parameters:

coder - The KeyCoder

Returns:

The count of Classes for which this KeyCoder was previously registered.

getRegisteredValueCoders

public Map<Class<?>,ValueCoder> getRegisteredValueCoders()

Create a Map of Classes to registered ValueCoders. The map is an unmodifiable, is sorted by class name, and does not change with subsequent registrations or removals of ValueCoders.

Specified by:

getRegisteredValueCoders in interface CoderManager

Returns:

Map of Classes to ValueCoders.

getRegisteredKeyCoders

public Map<Class<?>,KeyCoder> getRegisteredKeyCoders()

Create a Map of Classes to registered KeyCoder s. The map is an unmodifiable, and is sorted by class name, and does not change with subsequent registrations or unregistrations of KeyCoders.

Specified by:

getRegisteredKeyCoders in interface CoderManager

Returns:

Map of Classes to KeyCoder s.

lookupKeyCoder

public KeyCoder lookupKeyCoder(Class<?> clazz)

Returns the KeyCoder registered for the supplied Class, or null if no KeyCoder is registered.

Specified by:

lookupKeyCoder in interface CoderManager

Parameters:

clazz - The Class

Returns:

The KeyCoder or null if there is none.

registerValueCoder

public ValueCoder registerValueCoder(Class<?> clazz,
                                     ValueCoder coder)

Attempt to register the provided ValueCoder to encode and decode instances of supplied Class. If the class is included in the serial override set (see getSerialOverridePatterns() and if the ValueCoder is not an instance of SerialValueCoder, the request is ignored.

Specified by:

registerValueCoder in interface CoderManager

Parameters:

clazz - The Class for which this ValueCoder will provide encoding and decoding services

coder - The ValueCoder to register

Returns:

The ValueCoder that was removed, or null if there was none.

unregisterValueCoder

public ValueCoder unregisterValueCoder(Class<?> clazz)

Removes any ValueCoder registered for the supplied Class

Specified by:

unregisterValueCoder in interface CoderManager

Parameters:

clazz - The Class that will no longer have a ValueCoder

Returns:

The removed ValueCoder, or null if there was none.

unregisterValueCoder

public int unregisterValueCoder(ValueCoder coder)

Unregisters the supplied ValueCoder from all Classes it was previously registered to handle.

Specified by:

unregisterValueCoder in interface CoderManager

Parameters:

coder - The ValueCoder

Returns:

The count of Classes for which this ValueCoder was previously registered.

lookupValueCoder

public ValueCoder lookupValueCoder(Class<?> clazz)

Return the ValueCoder registered for the supplied Class , or null if no ValueCoder is registered.

Specified by:

lookupValueCoder in interface CoderManager

Parameters:

clazz - The Class

Returns:

The ValueCoder or null if there is none.

getValueCoder

public ValueCoder getValueCoder(Class<?> clazz)

Return a ValueCoder for the supplied Class. If there is none registered, implicitly create either a DefaultValueCoder or a SerialValueCoder and register it.

Specified by:

getValueCoder in interface CoderManager

Parameters:

clazz - The class for which a ValueCoder is needed

Returns:

The ValueCoder

getSerialOverridePatterns

public String getSerialOverridePatterns()

Returns the serialization override pattern specified by the serialOverride property. The pattern specifies a collection of names of classes that are required to be serialized by standard Java serialization rather than by a default or custom ValueCoder.

The result is a comma-delimited sequence of explicit class names and/or partial names that include wildcards. There are two wildcards: "**" standard for any character sequence, while "*" stands for any character sequence that having no periods. For example, the string

 
      java.util.ArrayList,java.util.*Map,java.lang.*,javax.swing.**
 
 

includes java.util.ArrayList, java.util.AbstractMap, java.util.HashMap, etc., all the classes in the java.lang package (but not java.lang.ref or java.lang.reflect), and all classes in javax.swing and all its sub-packages.

Returns:

The serialization override pattern

isSerialOverride

public boolean isSerialOverride(Class<?> clazz)

Tests whether the supplied class is included in the serial override set. This is a set of classes specified by the serialOverride property that are always serialized by standard Java serialization. Any attempt to register a custom ValueCoder or a DefaultObjectCoder for such a class will be ignored.

Parameters:

clazz - The class to test

Returns:

true if and only if the specified class is selected by the serialOverride property

See Also:

getSerialOverridePatterns()