org.openquark.cal.compiler.io
Class EntryPointSpec

java.lang.Object
  org.openquark.cal.compiler.io.EntryPointSpec

public final class EntryPointSpec
extends Object

EntryPointSpec encapsulates the information needed to generate an EntryPoint.

Author:

RCypher Created: Apr 8, 2004

See Also:

EntryPoint

Method Summary

static List<EntryPointSpec>	buildListFromQualifiedNames(Collection<QualifiedName> functionalAgentNames) Creates a list of entry point specifications with default input and output policies.
EntryPointSpec	cloneWithInputOutputPolicies(InputPolicy[] inputPolicies, OutputPolicy outputPolicy) Returns a new entry point spec with specified input/output policies
EntryPointSpec	cloneWithInputPolicies(InputPolicy[] inputPolicies) Returns a new entry point spec with specified input policies
EntryPointSpec	cloneWithOutputPolicy(OutputPolicy outputPolicy) Returns a new entry point spec with specified output policy
boolean	equals(Object other)
QualifiedName	getFunctionalAgentName() Get the functional agent name of this entry point spec.
InputPolicy[]	getInputPolicies() This gets an array containing all the input policies.
OutputPolicy	getOutputPolicy() Get the output policy.
int	hashCode()
static EntryPointSpec	make(QualifiedName functionalAgentName) Creates a new entry point specification with default input and output policies.
static EntryPointSpec	make(QualifiedName functionalAgentName, InputPolicy[] inputPolicies, OutputPolicy outputPolicy) Creates a new entry point specification with input and output policies
static EntryPointSpec	make(QualifiedName functionalAgentName, OutputPolicy outputPolicy) Creates a new entry point specification with default input policies and specified output policy.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

make

public static EntryPointSpec make(QualifiedName functionalAgentName)

Creates a new entry point specification with default input and output policies.

Parameters:

functionalAgentName - the qualified name of the functional agent to run

Returns:

the new entry point spec

make

public static EntryPointSpec make(QualifiedName functionalAgentName,
                                  OutputPolicy outputPolicy)

Creates a new entry point specification with default input policies and specified output policy.

Parameters:

functionalAgentName - the qualified name of the functional agent to run

outputPolicy - the output policy

Returns:

the new entry point spec

make

public static EntryPointSpec make(QualifiedName functionalAgentName,
                                  InputPolicy[] inputPolicies,
                                  OutputPolicy outputPolicy)

Creates a new entry point specification with input and output policies

Parameters:

functionalAgentName -

inputPolicies -

outputPolicy -

Returns:

the new entry point spec

buildListFromQualifiedNames

public static List<EntryPointSpec> buildListFromQualifiedNames(Collection<QualifiedName> functionalAgentNames)

Creates a list of entry point specifications with default input and output policies.

Parameters:

functionalAgentNames - collection of qualified names. This argument cannot be null.

Returns:

a list of entry point specs

getFunctionalAgentName

public final QualifiedName getFunctionalAgentName()

Get the functional agent name of this entry point spec. It cannot be null.

Returns:

the qualified name of the target.

getInputPolicies

public final InputPolicy[] getInputPolicies()

This gets an array containing all the input policies. It may be null, which means that default input policies are used. If it is zero length it means there are no inputs.

Returns:

an array of input policies, or null.

getOutputPolicy

public final OutputPolicy getOutputPolicy()

Get the output policy. This cannot be null.

Returns:

the output policy.

cloneWithOutputPolicy

public final EntryPointSpec cloneWithOutputPolicy(OutputPolicy outputPolicy)

Returns a new entry point spec with specified output policy

Parameters:

outputPolicy -

Returns:

entryPointSpec with new output policy

cloneWithInputPolicies

public final EntryPointSpec cloneWithInputPolicies(InputPolicy[] inputPolicies)

Returns a new entry point spec with specified input policies

Parameters:

inputPolicies -

Returns:

entryPointSpec with new input policies

cloneWithInputOutputPolicies

public final EntryPointSpec cloneWithInputOutputPolicies(InputPolicy[] inputPolicies,
                                                         OutputPolicy outputPolicy)

Returns a new entry point spec with specified input/output policies

Parameters:

inputPolicies -

outputPolicy -

Returns:

entryPointSpec with new input/output policies

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object