com.goldencode.p2j.startup.parameters

Class StartupParameter<T>

java.lang.Object

com.goldencode.p2j.startup.parameters.StartupParameter<T>

Direct Known Subclasses:

BooleanStartupParameter, IntegerStartupParameter, StringStartupParameter

public abstract class StartupParameter<T>
extends java.lang.Object

This abstract class encapsulates the common functionality for startup parameters of different types.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	name This is the parameter name used in FWD.
(package private) java.lang.String	originalName This is the original name used by OE.
(package private) java.lang.String	prefix This is the parameter prefix used in FWD.
(package private) T	value This is the actual value of the startup parameter

Constructor Summary

Constructors

Constructor and Description
StartupParameter(java.lang.String name, java.lang.String originalName) This is the default constructor.
StartupParameter(java.lang.String prefix, java.lang.String name, java.lang.String originalName) This is the default constructor.

Method Summary

Modifier and Type	Method and Description
T	getValue() Getter for the parameter vale.
abstract void	initFromBootstrap(BootstrapConfig bootstrapConfig) Initialize the parameter from the BootstrapConfig
abstract void	initFromDirectory() Initialize the parameter from the DirectoryService.
abstract void	readExternal(java.io.ObjectInput in) Used for helping with Externalizable.readExternal(ObjectInput)
java.lang.String	toString() Overrides te default Object.toString() method.
abstract void	writeExternal(java.io.ObjectOutput out) Used for helping with Externalizable.writeExternal(ObjectOutput)

Methods inherited from class java.lang.Object

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

Field Detail

value

T value

This is the actual value of the startup parameter

prefix

final java.lang.String prefix

This is the parameter prefix used in FWD.

name

final java.lang.String name

This is the parameter name used in FWD.

originalName

final java.lang.String originalName

This is the original name used by OE.

Constructor Detail

StartupParameter

public StartupParameter(java.lang.String name,
                        java.lang.String originalName)

This is the default constructor.

Parameters:

name - is the parameter name used by FWD.

originalName - is the original name used by OE.

StartupParameter

public StartupParameter(java.lang.String prefix,
                        java.lang.String name,
                        java.lang.String originalName)

This is the default constructor.

Parameters:

prefix - is the parameter name prefix used by FWD.

name - is the parameter name used by FWD.

originalName - is the original name used by OE.

Method Detail

getValue

public T getValue()

Getter for the parameter vale.

Returns:

the parameter value.

initFromDirectory

public abstract void initFromDirectory()

Initialize the parameter from the DirectoryService.

initFromBootstrap

public abstract void initFromBootstrap(BootstrapConfig bootstrapConfig)

Initialize the parameter from the BootstrapConfig

Parameters:

bootstrapConfig - is the bootstrap configuration.

readExternal

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

Used for helping with Externalizable.readExternal(ObjectInput)

Parameters:

in - the stream to read data from in order to restore the object

Throws:

java.io.IOException - if I/O errors occur

writeExternal

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

Used for helping with Externalizable.writeExternal(ObjectOutput)

Parameters:

out - the stream to write the object to

Throws:

java.io.IOException - Includes any I/O exceptions that may occur

toString

public java.lang.String toString()

Overrides te default Object.toString() method. If the value is null, it returns null.

Overrides:

toString in class java.lang.Object

Returns:

a string containing the original name and the value.