org.jlab.coda.cMsg.remoteExec

Class ConstructorInfo

java.lang.Object

org.jlab.coda.cMsg.remoteExec.ConstructorInfo

public class ConstructorInfo
extends java.lang.Object

This class stores all arguments needed to construct an object. This information is stored in a cMsgMessage object which is a useful format when sending data using cMsg.

Author:

timmer Date: Oct 28, 2010

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.LinkedList<org.jlab.coda.cMsg.remoteExec.ConstructorInfo.ConstructorArg>	argList List of arguments.
(package private) int	numPrimitiveArgs Number of primitive type arguments.
(package private) int	numReferenceArgs Number of reference type arguments that are not null or do not use a no-arg constructor.

Constructor Summary

Constructors

Constructor and Description
ConstructorInfo() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addPrimitiveArg(char value) Add to the argument list a primitive char type with the given value.
void	addPrimitiveArg(char value, int index) Add to the argument list a primitive char type with the given value at the given index into the existing list of arguments.
void	addPrimitiveArg(java.lang.String name, java.lang.String value) Add to the argument list a primitive type (except char) with the given value.
void	addPrimitiveArg(java.lang.String name, java.lang.String value, int index) Add to the argument list a primitive type (except char) with the given value at the given index into the existing list of arguments.
void	addReferenceArg(java.lang.String className, ConstructorInfo info) Add to the argument list a reference type with the information necessary to construct it.
void	addReferenceArg(java.lang.String className, ConstructorInfo info, int index) Add to the argument list a reference type with the information necessary to construct it at the given index into the existing list of arguments.
void	clearArgs() Clear all arguments.
cMsgMessage	createMessageFromArgs() Take argument specification data and store it in a cMsg message.

Methods inherited from class java.lang.Object

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

Field Detail

numPrimitiveArgs

int numPrimitiveArgs

Number of primitive type arguments.

numReferenceArgs

int numReferenceArgs

Number of reference type arguments that are not null or do not use a no-arg constructor.

argList

java.util.LinkedList<org.jlab.coda.cMsg.remoteExec.ConstructorInfo.ConstructorArg> argList

List of arguments.

Constructor Detail

ConstructorInfo

public ConstructorInfo()

Constructor.

Method Detail

clearArgs

public void clearArgs()

Clear all arguments.

addPrimitiveArg

public void addPrimitiveArg(java.lang.String name,
                            java.lang.String value)
                     throws cMsgException

Add to the argument list a primitive type (except char) with the given value. Valid names are: int, boolean, char, byte, short, long, float, double.

Parameters:

name - name of primitive type

value - value of the argument in String form

Throws:

cMsgException - if name is reference type, char, or null

addPrimitiveArg

public void addPrimitiveArg(java.lang.String name,
                            java.lang.String value,
                            int index)
                     throws cMsgException

Add to the argument list a primitive type (except char) with the given value at the given index into the existing list of arguments. Valid names are: int, boolean, char, byte, short, long, float, double.

Parameters:

name - name of primitive type

value - value of the argument in String form

index - index into the existing argument list at which to add this arg

Throws:

cMsgException - if name is reference type, char, or null

addPrimitiveArg

public void addPrimitiveArg(char value)

Add to the argument list a primitive char type with the given value.

Parameters:

value - value of the argument

addPrimitiveArg

public void addPrimitiveArg(char value,
                            int index)

Add to the argument list a primitive char type with the given value at the given index into the existing list of arguments.

Parameters:

value - value of the argument

index - index into the existing argument list at which to add this arg

addReferenceArg

public void addReferenceArg(java.lang.String className,
                            ConstructorInfo info)
                     throws cMsgException

Add to the argument list a reference type with the information necessary to construct it.

Parameters:

className - name of class to instantiate

info - object containing argument data for instantiation

Throws:

cMsgException - if className refers to primitive type or is null

addReferenceArg

public void addReferenceArg(java.lang.String className,
                            ConstructorInfo info,
                            int index)
                     throws cMsgException

Add to the argument list a reference type with the information necessary to construct it at the given index into the existing list of arguments.

Parameters:

className - name of class to instantiate

info - object containing argument data for instantiation

index - index into the existing argument list at which to add this arg

Throws:

cMsgException - if className refers to primitive type or is null

createMessageFromArgs

public cMsgMessage createMessageFromArgs()

Take argument specification data and store it in a cMsg message.

Returns:

cMsg message containing argument data; null if no args.