com.joanju.cg.api
Class CallScriptReturn

java.lang.Object
  com.joanju.cg.api.CallScriptReturn

public class CallScriptReturn
extends java.lang.Object

A CallScript.groovy go() method must return null or one of these.

There are two lists of values. One is the list of procedure names. Examples: myInternalProc, myExternal.p, myUserFunction. The second is the list of values for handles. The list of values for handles is just the list of persistent external program names (.p, .w, etc.). Of course, in many cases, there will only be one value in either list.

Don't add anything to the list if you want Callgraph to resolve the procedure name or the handle. I.e., your script resolves the handle, but Callgraph resolves the procedure name, or vise versa.

You can add a null to the list. A null is treated as "unresolved". It is perfectly valid to tell Callgraph that a procedure name or handle has a few resolved values, but is also partly unresolved.

Constructor Summary

CallScriptReturn()

Method Summary

void	addHandleValue(java.lang.String externalProgramName) Add one value to the list of external program names for the call's handle.
void	addHandleValues(java.util.Collection externalProgramNames) Add a collection of values to the list of external program names for the call's handle.
void	addProcedureName(java.lang.String name) Add one name to the list of procedure names for the call.
void	addProcedureNames(java.util.Collection names) Add a collection of names to the list of procedure names for the call.
java.util.Collection<java.lang.String>	getHandleValues()
java.util.Collection<java.lang.String>	getProcedureNames()
boolean	hasHandleValues()
boolean	hasProcedureNames()

Methods inherited from class java.lang.Object

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

Constructor Detail

CallScriptReturn

public CallScriptReturn()

Method Detail

addHandleValue

public void addHandleValue(java.lang.String externalProgramName)

Add one value to the list of external program names for the call's handle.

See Also:

CallScriptReturn

addHandleValues

public void addHandleValues(java.util.Collection externalProgramNames)

Add a collection of values to the list of external program names for the call's handle.

See Also:

CallScriptReturn

addProcedureName

public void addProcedureName(java.lang.String name)

Add one name to the list of procedure names for the call.

See Also:

CallScriptReturn

addProcedureNames

public void addProcedureNames(java.util.Collection names)

Add a collection of names to the list of procedure names for the call.

See Also:

CallScriptReturn

getHandleValues

public java.util.Collection<java.lang.String> getHandleValues()

getProcedureNames

public java.util.Collection<java.lang.String> getProcedureNames()

hasHandleValues

public boolean hasHandleValues()

hasProcedureNames

public boolean hasProcedureNames()