net.jxta.util
Class ClassFactory

java.lang.Object
  |
  +--net.jxta.util.ClassFactory

Direct Known Subclasses:

AdvertisementFactory, IDFactory, StructuredDocumentFactory

public abstract class ClassFactory

extends java.lang.Object

This util class provides methods needed by class construction factories. FIXME bondolo@jxta.org 20010223 This implementation needs a way to return the list of key -> class associations

Since:

JXTA 1.0

Version:

$Revision: 1.17 $

See Also:

StructuredDocumentFactory, AdvertisementFactory, IDFactory

Constructor Summary

protected

ClassFactory() Constructor for ClassFactory.

Method Summary

protected abstract java.util.Hashtable	getAssocTable() Used by ClassFactory methods to get the mapping of keys to constructors.
protected java.util.Enumeration	getAvailableKeys() Return all of the available keys for this factory.
protected abstract java.lang.Class	getClassForKey() Used by ClassFactory methods to ensure that all keys used with the mapping are of the correct type.
protected abstract java.lang.Class	getClassOfInstantiators() Used by ClassFactory methods to ensure that all of the instance classes which register with this factory have the correct base class
protected java.lang.Object	getInstantiator(java.lang.Object key) Return the instantiator associated with the provided key.
protected boolean	registerAssoc(java.lang.Object key, java.lang.Object instantiator) Register a key and instance class with the factory.
protected boolean	registerAssoc(java.lang.String className) Register a class with the factory from its class name.
protected boolean	registerFromResources(java.lang.String resourceName, java.lang.String propertyName) Given a resource bundle identifier and a property name register instance classes.
protected boolean	registerFromString(java.lang.String classNamesString) Register instance classes given a string containing class names which must be found on the current class path.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassFactory

protected ClassFactory()

Constructor for ClassFactory. Instances of ClassFactory are created only by the singleton subclasses.

Method Detail

getAssocTable

protected abstract java.util.Hashtable getAssocTable()

Used by ClassFactory methods to get the mapping of keys to constructors.

Returns:

the hashtable containing the mappings.

Since:

JXTA 1.0

getClassForKey

protected abstract java.lang.Class getClassForKey()

Used by ClassFactory methods to ensure that all keys used with the mapping are of the correct type.

Returns:

Class object of the key type.

Since:

JXTA 1.0

getAvailableKeys

protected java.util.Enumeration getAvailableKeys()

Return all of the available keys for this factory. All elements will be of the same type as the result as getClassForKey.

Returns:

Enumeration containing all of the available keys for this factory. All elements will be of the same type as the result as getClassForKey.

Since:

JXTA 1.0

getClassOfInstantiators

protected abstract java.lang.Class getClassOfInstantiators()

Used by ClassFactory methods to ensure that all of the instance classes which register with this factory have the correct base class

Returns:

Class object of the "Factory" type.

Since:

JXTA 1.0

registerFromResources

protected boolean registerFromResources(java.lang.String resourceName,
                                        java.lang.String propertyName)
                                 throws java.util.MissingResourceException

Given a resource bundle identifier and a property name register instance classes. The property must be a string containing class names which must be found on the current class path. The class names are seperated by spaces.

Parameters:

resourceName - name of the resource bundle

propertyName - name of the property.

Returns:

boolean true if at least one instance class could be registered with this factory.

Throws:

java.util.MissingResourceException - if the resource bundle or property cannot be located.

Since:

JXTA 1.0

registerFromString

protected boolean registerFromString(java.lang.String classNamesString)

Register instance classes given a string containing class names which must be found on the current class path. The class names are seperated by spaces.

Parameters:

classNamesString - The class name list

Returns:

boolean true if at least one of the instance classes could be registered otherwise false.

Since:

JXTA 1.0

registerAssoc

protected boolean registerAssoc(java.lang.String className)
                         throws java.lang.Exception

Register a class with the factory from its class name. Since class name doesn't tell us much, we just load the class and hope that something happens as a result of the class loading. This class is often overridden in class factories to interogate the instance class before registering the instance class.

Parameters:

className - The class name which will be regiestered.

Returns:

boolean true if the class was registered otherwise false.

Throws:

java.lang.Exception - when an error occurs.

Since:

JXTA 1.0

registerAssoc

protected boolean registerAssoc(java.lang.Object key,
                                java.lang.Object instantiator)

Register a key and instance class with the factory.

Parameters:

key - The key to register.

instantiator - The instantiator object which will be registered for this key.

Returns:

boolean true if the key was successfully registered otherwise false.

Since:

JXTA 1.0

getInstantiator

protected java.lang.Object getInstantiator(java.lang.Object key)
                                    throws java.util.NoSuchElementException

Return the instantiator associated with the provided key.

Parameters:

key - The identifier for the Instantiator class to be returned.

Returns:

Instantiator Instantiator matching the provided key

Throws:

java.util.NoSuchElementException - if the key has not been registerd.

Since:

JXTA 1.0