com.goldencode.p2j.startup.parameters

Class StringStartupParameter

java.lang.Object

com.goldencode.p2j.startup.parameters.StartupParameter<java.lang.String>

com.goldencode.p2j.startup.parameters.StringStartupParameter

public final class StringStartupParameter
extends StartupParameter<java.lang.String>

This class encapsulates the functionality for String startup parameters.

Field Summary

Fields inherited from class com.goldencode.p2j.startup.parameters.StartupParameter

name, originalName, prefix, value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	initFromBootstrap(BootstrapConfig bootstrapConfig) Initialize the parameter from the BootstrapConfig
void	initFromDirectory() Initialize the parameter from the DirectoryService.
void	readExternal(java.io.ObjectInput in) Used for helping with Externalizable.readExternal(ObjectInput)
void	writeExternal(java.io.ObjectOutput out) Used for helping with Externalizable.writeExternal(ObjectOutput)

Methods inherited from class com.goldencode.p2j.startup.parameters.StartupParameter

getValue, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringStartupParameter

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

This is the default constructor which calls the StartupParameter constructor.

Parameters:

name - is the parameter name used by FWD.

originalName - is the original name used by OE.

StringStartupParameter

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

This is the default constructor which calls the StartupParameter 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

initFromDirectory

public void initFromDirectory()

Initialize the parameter from the DirectoryService.

Specified by:

initFromDirectory in class StartupParameter<java.lang.String>

initFromBootstrap

public void initFromBootstrap(BootstrapConfig bootstrapConfig)

Initialize the parameter from the BootstrapConfig

Specified by:

initFromBootstrap in class StartupParameter<java.lang.String>

Parameters:

bootstrapConfig - is the bootstrap configuration.

readExternal

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

Used for helping with Externalizable.readExternal(ObjectInput)

Specified by:

readExternal in class StartupParameter<java.lang.String>

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 void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Used for helping with Externalizable.writeExternal(ObjectOutput)

Specified by:

writeExternal in class StartupParameter<java.lang.String>

Parameters:

out - the stream to write the object to

Throws:

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