orca.shirako.plugins.config
Class Config

java.lang.Object
  orca.shirako.plugins.config.Config

All Implemented Interfaces:

IInitialize, ISerialize

Direct Known Subclasses:

AntConfig

public class Config
extends java.lang.Object
implements IInitialize, ISerialize

Field Summary

protected boolean	initialized
protected boolean	isSynchronous
protected LoggingTool	logger
protected ShirakoPlugin	plugin
static java.lang.String	PropertyActionSequenceNumber Sequence number for the configuration action.
static java.lang.String	PropertyConfig Specifies a configuration file or action to execute.
static java.lang.String	PropertyConfigurationProperties
static java.lang.String	PropertyExceptionMessage
static java.lang.String	PropertyExceptionStack
static java.lang.String	PropertyOutputPrefix Any property in the ant project file starting with this prefix will be passed back to the java code.
static java.lang.String	PropertyResourceType
static java.lang.String	PropertySavePrefix
static java.lang.String	PropertyTargetName
static java.lang.String	PropertyTargetResultCode
static java.lang.String	PropertyTargetResultCodeMessage
static java.lang.String	PropertyUnitAll
static int	ResultCodeException
static int	ResultCodeOK
static java.lang.String	TargetJoin
static java.lang.String	TargetLeave
static java.lang.String	TargetModify
static java.lang.String	TargetProbe
static java.lang.String	TargetRecover

Constructor Summary

Config()

Config(ShirakoPlugin plugin)

Method Summary

static long	getActionSequenceNumber(java.util.Properties p)
void	initialize() Initializes the object.
void	join(java.lang.Object token, java.util.Properties p)
void	leave(java.lang.Object token, java.util.Properties p)
void	modify(java.lang.Object token, java.util.Properties p)
protected void	printProperties(java.util.Properties p)
void	probe(java.lang.Object token, java.util.Properties p)
void	recover(java.lang.Object token, java.util.Properties p) Deprecated.
void	reset(java.util.Properties p) De-serializes the object from the given properties list.
void	revisit(IActor actor, java.util.Properties p) Reset/restore interface.
java.util.Properties	save() Serializes the object into a properties list.
void	save(java.util.Properties p) Serializes the object into the given properties list.
static void	setActionSequenceNumber(java.util.Properties p, long sequence)
static void	setAll(java.util.Properties p)
void	setLogger(LoggingTool logger)
void	setSlicesPlugin(ShirakoPlugin plugin)

Methods inherited from class java.lang.Object

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

Field Detail

PropertyConfig

public static final java.lang.String PropertyConfig

Specifies a configuration file or action to execute.

See Also:

Constant Field Values

PropertyOutputPrefix

public static final java.lang.String PropertyOutputPrefix

Any property in the ant project file starting with this prefix will be passed back to the java code.

See Also:

Constant Field Values

PropertyExceptionMessage

public static final java.lang.String PropertyExceptionMessage

See Also:

Constant Field Values

PropertyExceptionStack

public static final java.lang.String PropertyExceptionStack

See Also:

Constant Field Values

PropertyTargetName

public static final java.lang.String PropertyTargetName

See Also:

Constant Field Values

PropertyTargetResultCode

public static final java.lang.String PropertyTargetResultCode

See Also:

Constant Field Values

PropertyTargetResultCodeMessage

public static final java.lang.String PropertyTargetResultCodeMessage

See Also:

Constant Field Values

PropertyConfigurationProperties

public static final java.lang.String PropertyConfigurationProperties

See Also:

Constant Field Values

PropertySavePrefix

public static final java.lang.String PropertySavePrefix

See Also:

Constant Field Values

PropertyActionSequenceNumber

public static final java.lang.String PropertyActionSequenceNumber

Sequence number for the configuration action.

See Also:

Constant Field Values

ResultCodeException

public static final int ResultCodeException

See Also:

Constant Field Values

ResultCodeOK

public static final int ResultCodeOK

See Also:

Constant Field Values

TargetJoin

public static final java.lang.String TargetJoin

See Also:

Constant Field Values

TargetLeave

public static final java.lang.String TargetLeave

See Also:

Constant Field Values

TargetProbe

public static final java.lang.String TargetProbe

See Also:

Constant Field Values

TargetRecover

public static final java.lang.String TargetRecover

See Also:

Constant Field Values

TargetModify

public static final java.lang.String TargetModify

See Also:

Constant Field Values

PropertyResourceType

public static final java.lang.String PropertyResourceType

See Also:

Constant Field Values

PropertyUnitAll

public static final java.lang.String PropertyUnitAll

See Also:

Constant Field Values

plugin

protected ShirakoPlugin plugin

logger

protected LoggingTool logger

isSynchronous

protected boolean isSynchronous

initialized

protected boolean initialized

Constructor Detail

Config

public Config()

Config

public Config(ShirakoPlugin plugin)

Method Detail

initialize

public void initialize()
                throws java.lang.Exception

Description copied from interface: IInitialize

Initializes the object.

Specified by:

initialize in interface IInitialize

Throws:

java.lang.Exception

save

public java.util.Properties save()
                          throws java.lang.Exception

Description copied from interface: ISerialize

Serializes the object into a properties list.

Specified by:

save in interface ISerialize

Returns:

properties list representing this object

Throws:

java.lang.Exception

save

public void save(java.util.Properties p)
          throws java.lang.Exception

Description copied from interface: ISerialize

Serializes the object into the given properties list.

Specified by:

save in interface ISerialize

Parameters:

p - properties list to serialize the object into

Throws:

java.lang.Exception

reset

public void reset(java.util.Properties p)
           throws java.lang.Exception

Description copied from interface: ISerialize

De-serializes the object from the given properties list.

Specified by:

reset in interface ISerialize

Parameters:

p - properties list containing the serialized version of the object

Throws:

java.lang.Exception

revisit

public void revisit(IActor actor,
                    java.util.Properties p)
             throws java.lang.Exception

Reset/restore interface. Reset the mapper attributes.

Throws:

java.lang.Exception

printProperties

protected void printProperties(java.util.Properties p)

join

public void join(java.lang.Object token,
                 java.util.Properties p)
          throws java.lang.Exception

Parameters:

token - A token to use for the callback

p -

Throws:

java.lang.Exception

leave

public void leave(java.lang.Object token,
                  java.util.Properties p)
           throws java.lang.Exception

Throws:

java.lang.Exception

probe

public void probe(java.lang.Object token,
                  java.util.Properties p)
           throws java.lang.Exception

Throws:

java.lang.Exception

recover

@Deprecated
public void recover(java.lang.Object token,
                               java.util.Properties p)
             throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

modify

public void modify(java.lang.Object token,
                   java.util.Properties p)
            throws java.lang.Exception

Throws:

java.lang.Exception

setLogger

public void setLogger(LoggingTool logger)

setSlicesPlugin

public void setSlicesPlugin(ShirakoPlugin plugin)

setAll

public static void setAll(java.util.Properties p)

setActionSequenceNumber

public static void setActionSequenceNumber(java.util.Properties p,
                                           long sequence)

getActionSequenceNumber

public static long getActionSequenceNumber(java.util.Properties p)