eventweb.net.srvr

Class SrvcRegistry

java.lang.Object

eventweb.net.srvr.SrvcRegistry

public class SrvcRegistry
extends java.lang.Object

Provides a mechanism for different services to obtain the same instance of an object.

Object instances in the registry are indexed by the the string representation of the object name.
Only one object of a given type can exist. An object can be inserted under multiple types if all additional types are superclasses of the object's native type.

Version:

1.3.0 02/19/08

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies.
static java.lang.String	VERSION Class version.

Constructor Summary

Constructors

Constructor and Description
SrvcRegistry() Create a new Service Registry.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addObject(java.lang.Object inst) Add an object to the registry.
boolean	addObjectSuperclass(java.lang.Object inst, java.lang.Class sClass) Add an object to the registry under a superclass type.
boolean	containsClass(java.lang.Class regClass) Determine if the registry contains an object of type regClass.
java.lang.Object	createObject(java.lang.String className, java.lang.String params) Create an object, initialize it, and add it to the registry.
java.lang.Object	getObject(java.lang.Class regClass) Get an object instance from the registry.
static SrvcRegistry	getRegistry() Get a reference to the root registry.
java.util.Iterator	nameIterator() Get an iterator over the class names in the registry.
java.lang.Object	obtainObject(java.lang.Class regClass, java.lang.String params) Get an object instance from the registry.
java.lang.Object	obtainObject(java.lang.Class regClass, java.lang.String params, boolean registerNew) Get an object instance from the registry.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

Class version.

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies.

Constructor Detail

SrvcRegistry

public SrvcRegistry()

Create a new Service Registry.

Method Detail

getRegistry

public static SrvcRegistry getRegistry()

Get a reference to the root registry.

containsClass

public boolean containsClass(java.lang.Class regClass)

Determine if the registry contains an object of type regClass.

Parameters:

regClass - The class to look for

Returns:

true, if an object is registered

addObject

public boolean addObject(java.lang.Object inst)

Add an object to the registry.
If an object of the same type is already in the registry, the new instance will not be added, and the method will return false.

Parameters:

inst - Object instance to be added

Returns:

true, if the object is successfully added

addObjectSuperclass

public boolean addObjectSuperclass(java.lang.Object inst,
                          java.lang.Class sClass)

Add an object to the registry under a superclass type.

sClass must be a superclass of inst. If an object of the same type is already in the registry, or the type of inst is not a subclass of sClass, the new instance will not be added, and the method will return false.
The same instance can be added under it's own type (using addObject), and again under a superclass (using addObjectSuperclass)

Parameters:

inst - Object instance to be added.

sClass - Superclass to add the object under.

Returns:

true, if the object is successfully added.

createObject

public java.lang.Object createObject(java.lang.String className,
                            java.lang.String params)

Create an object, initialize it, and add it to the registry. If an object of the specified type already exists, it will be returned, and no new instance will be created.

This is a convienence method for creating and adding objects to the registry. If the object created does not implement the RegInit interface, it will be created and added to the registry, but it will not be initialized. If the object does not have a zero parameter constructor, the method will fail, and null will be returned

Parameters:

className - The name of the class to be obtained.

params - Initialization parameters. (Can be null.)

Returns:

The object obtained, or null if the method failed.

getObject

public java.lang.Object getObject(java.lang.Class regClass)

Get an object instance from the registry.

Parameters:

regClass - The class of the object to be obtained.

Returns:

The object instance, null if none is found.

obtainObject

public java.lang.Object obtainObject(java.lang.Class regClass,
                            java.lang.String params)

Get an object instance from the registry. If none exists, create a new instance.
The initialization parameters are only used if a new instance is created. If a new instance is created, it is not added to the registry.

Parameters:

regClass - The class of the object to be obtained.

params - Initialization parameters. (Can be null.)

Returns:

The object instance, null if the method fails.

obtainObject

public java.lang.Object obtainObject(java.lang.Class regClass,
                            java.lang.String params,
                            boolean registerNew)

Get an object instance from the registry. If none exists, create a new instance.
The initialization parameters are only used if a new instance is created.

Parameters:

regClass - The class of the object to be obtained.

params - Initialization parameters. (Can be null.)

registerNew - If true, and a new instance is created, add it to the registry.

Returns:

The object instance, null if the method fails.

nameIterator

public java.util.Iterator nameIterator()

Get an iterator over the class names in the registry.

Returns:

The iterator