ActionSignatureImpl (CZT Corejava Circus 1.6-SNAPSHOT API)

java.lang.Object
- net.sourceforge.czt.base.impl.TermImpl
- - net.sourceforge.czt.circus.impl.CircusSignatureImpl
  - - net.sourceforge.czt.circus.impl.ActionSignatureImpl

All Implemented Interfaces:

Term, ActionSignature, CircusSignature
```
public class ActionSignatureImpl
extends CircusSignatureImpl
implements ActionSignature
```
An implementation of the interface ActionSignature.

Author:

GnAST version 1.6-SNAPSHOT

Field Summary
- Fields inherited from interface net.sourceforge.czt.circus.ast.ActionSignature
  FORMAL_PARAMS_INDEX, LOCAL_VARS_INDEX, USED_CHANNELS_INDEX

Constructor Summary

Constructors
Modifier Constructor and Description

protected ActionSignatureImpl()
The default constructor.

protected ActionSignatureImpl(BaseFactory factory)

Constructors
Modifier	Constructor and Description
`protected`	`ActionSignatureImpl()` The default constructor.
`protected`	`ActionSignatureImpl(BaseFactory factory)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R> R`	`accept(Visitor<R> v)` Accepts a visitor.
`static boolean`	`countingFinaliser()` public attribute determining whether to log to the standard output information about who is creating this instance of ActionSignatureImpl (e.g., ic >= sl)
`ActionSignatureImpl`	`create(Object[] args)` Returns a new object of this class.
`boolean`	`equals(Object obj)` Compares the specified object with this ActionSignatureImpl for equality.
`Name`	`getActionName()` This is a convenience method for getName.
`ZName`	`getActionZName()` This is a convenience method.
`ChannelSetList`	`getChannelSetList()` Returns the ChannelSetList element.
`Object[]`	`getChildren()`
`CommunicationList`	`getCommunicationList()` Returns the CommunicationList element.
`Signature`	`getFormalParams()` This is a convenience method.
`Signature`	`getLocalVars()` This is a convenience method.
`NameSetList`	`getNameSetList()` Returns the NameSetList element.
`SignatureList`	`getSignatureList()` Returns the SignatureList element.
`Signature`	`getUsedChannels()` This is a convenience method.
`CircusChannelSetList`	`getUsedChannelSets()` This is a convenience method.
`CircusCommunicationList`	`getUsedCommunications()` This is a convenience method.
`CircusNameSetList`	`getUsedNameSets()` This is a convenience method.
`ZSignatureList`	`getZSignatureList()` This is a convenience method.
`int`	`hashCode()` Returns the hash code value for this ActionSignatureImpl.
`static long`	`instanceCount()` Only concrete classes get the instance count method visible
`static long`	`instancesFinalised()`
`boolean`	`isParamAction()` Returns whether or not this is a signature for parameterised action or not (i.e.
`void`	`setActionName(Name name)` This is a convenience method for setName.
`void`	`setChannelSetList(ChannelSetList channelSetList)` Sets the ChannelSetList element.
`void`	`setCommunicationList(CommunicationList communicationList)` Sets the CommunicationList element.
`Signature`	`setFormalParams(Signature sig)` This is a convenience method.
`Signature`	`setLocalVars(Signature sig)` This is a convenience method.
`void`	`setNameSetList(NameSetList nameSetList)` Sets the NameSetList element.
`void`	`setSignatureList(SignatureList signatureList)` Sets the SignatureList element.
`Signature`	`setUsedChannels(Signature sig)` This is a convenience method.

Methods inherited from class net.sourceforge.czt.circus.impl.CircusSignatureImpl
getName, getZName, setName

Methods inherited from class net.sourceforge.czt.base.impl.TermImpl
annsSize, getAnn, getAnns, getFactory, hasAnn, hasAnn, removeAnn, removeAnn, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sourceforge.czt.circus.ast.CircusSignature
getName, getZName, setName

Methods inherited from interface net.sourceforge.czt.base.ast.Term
annsSize, getAnn, getAnns, hasAnn, hasAnn, removeAnn, removeAnn

- Constructor Detail
  - ActionSignatureImpl
```
protected ActionSignatureImpl()
```
    The default constructor. Do not use it explicitly, unless you are extending this class. If you want to create an instance of this class, please use the object factory.
  - ActionSignatureImpl
```
protected ActionSignatureImpl(BaseFactory factory)
```
- Method Detail
  - countingFinaliser
```
public static boolean countingFinaliser()
```
    public attribute determining whether to log to the standard output information about who is creating this instance of ActionSignatureImpl (e.g., ic >= sl)
  - instancesFinalised
```
public static long instancesFinalised()
```
  - equals
```
public boolean equals(Object obj)
```
    Compares the specified object with this ActionSignatureImpl for equality. Returns true if and only if the specified object is also a(n) ActionSignatureImpl and all the getter methods except getAnns return equal objects.
    
    Overrides:
    
    equals in class CircusSignatureImpl
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this ActionSignatureImpl.
    
    Overrides:
    
    hashCode in class CircusSignatureImpl
  - accept
```
public <R> R accept(Visitor<R> v)
```
    Accepts a visitor.
    
    Specified by:
    
    accept in interface Term
    
    Overrides:
    
    accept in class CircusSignatureImpl
  - create
```
public ActionSignatureImpl create(Object[] args)
```
    Returns a new object of this class.
    
    Specified by:
    
    create in interface Term
  - getChildren
```
public Object[] getChildren()
```
    Specified by:
    
    getChildren in interface Term
  - instanceCount
```
public static long instanceCount()
```
    Only concrete classes get the instance count method visible
  - getSignatureList
```
public SignatureList getSignatureList()
```
    Description copied from interface: ActionSignature
    
    Returns the SignatureList element.
    
    Specified by:
    
    getSignatureList in interface ActionSignature
    
    Returns:
    
    the SignatureList element.
  - setSignatureList
```
public void setSignatureList(SignatureList signatureList)
```
    Description copied from interface: ActionSignature
    
    Sets the SignatureList element.
    
    Specified by:
    
    setSignatureList in interface ActionSignature
    
    Parameters:
    
    signatureList - the SignatureList element.
    
    See Also:
    
    ActionSignature.getSignatureList()
  - getCommunicationList
```
public CommunicationList getCommunicationList()
```
    Description copied from interface: ActionSignature
    
    Returns the CommunicationList element.
    
    Specified by:
    
    getCommunicationList in interface ActionSignature
    
    Returns:
    
    the CommunicationList element.
  - setCommunicationList
```
public void setCommunicationList(CommunicationList communicationList)
```
    Description copied from interface: ActionSignature
    
    Sets the CommunicationList element.
    
    Specified by:
    
    setCommunicationList in interface ActionSignature
    
    Parameters:
    
    communicationList - the CommunicationList element.
    
    See Also:
    
    ActionSignature.getCommunicationList()
  - getChannelSetList
```
public ChannelSetList getChannelSetList()
```
    Description copied from interface: ActionSignature
    
    Returns the ChannelSetList element.
    
    Specified by:
    
    getChannelSetList in interface ActionSignature
    
    Returns:
    
    the ChannelSetList element.
  - setChannelSetList
```
public void setChannelSetList(ChannelSetList channelSetList)
```
    Description copied from interface: ActionSignature
    
    Sets the ChannelSetList element.
    
    Specified by:
    
    setChannelSetList in interface ActionSignature
    
    Parameters:
    
    channelSetList - the ChannelSetList element.
    
    See Also:
    
    ActionSignature.getChannelSetList()
  - getNameSetList
```
public NameSetList getNameSetList()
```
    Description copied from interface: ActionSignature
    
    Returns the NameSetList element.
    
    Specified by:
    
    getNameSetList in interface ActionSignature
    
    Returns:
    
    the NameSetList element.
  - setNameSetList
```
public void setNameSetList(NameSetList nameSetList)
```
    Description copied from interface: ActionSignature
    
    Sets the NameSetList element.
    
    Specified by:
    
    setNameSetList in interface ActionSignature
    
    Parameters:
    
    nameSetList - the NameSetList element.
    
    See Also:
    
    ActionSignature.getNameSetList()
  - getActionName
```
public Name getActionName()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method for getName.
    
    Specified by:
    
    getActionName in interface ActionSignature
  - getActionZName
```
public ZName getActionZName()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It returns the ZName if getName is an instance of ZName and throws an UnsupportedAstClassException otherwise.
    
    Specified by:
    
    getActionZName in interface ActionSignature
  - setActionName
```
public void setActionName(Name name)
```
    Description copied from interface: ActionSignature
    
    This is a convenience method for setName.
    
    Specified by:
    
    setActionName in interface ActionSignature
  - isParamAction
```
public boolean isParamAction()
```
    Description copied from interface: ActionSignature
    
    Returns whether or not this is a signature for parameterised action or not (i.e. it has a non-empty list of formal parameters).
    
    Specified by:
    
    isParamAction in interface ActionSignature
  - getZSignatureList
```
public ZSignatureList getZSignatureList()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It returns the ZSignatureList if getSignatureList() is an instance of ZSignatureList and throws a UnsupportedAstClassException otherwise.
    
    Specified by:
    
    getZSignatureList in interface ActionSignature
  - getFormalParams
```
public Signature getFormalParams()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It represents the non-null (possibly empty) signature of arguments for this action signature (i.e. its declared formal parameters). It returns the Signature from getZSignatureList().get(FORMAL_PARAMS_INDEX). It may throw a a UnsupportedAstClassException from getZSignatureList().
    
    Specified by:
    
    getFormalParams in interface ActionSignature
  - setFormalParams
```
public Signature setFormalParams(Signature sig)
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It sets the given non-null (possibly empty) signature of the formal parameters signature of this action. It is the same as getZSignatureList().set(FORMAL_PARAMS_INDEX, sig). It may throw a a UnsupportedAstClassException from getMainSignatures(). The result is the old value previously stored (if any).
    
    Specified by:
    
    setFormalParams in interface ActionSignature
  - getLocalVars
```
public Signature getLocalVars()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It represents the non-null (possibly empty) signature of locally declared variables for this action signature (i.e. circvar commands). It returns the Signature from getZSignatureList().get(LOCAL_VARS_INDEX). It may throw a a UnsupportedAstClassException from getZSignatureList().
    
    Specified by:
    
    getLocalVars in interface ActionSignature
  - setLocalVars
```
public Signature setLocalVars(Signature sig)
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It sets the given non-null (possibly empty) signature of the local variables signature of this action. It is the same as getZSignatureList().set(LOCAL_VARS_INDEX, sig). It may throw a a UnsupportedAstClassException from getMainSignatures(). The result is the old value previously stored (if any).
    
    Specified by:
    
    setLocalVars in interface ActionSignature
  - getUsedChannels
```
public Signature getUsedChannels()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It represents the non-null (possibly empty) signature of used channels for this action signature. This contains the channel name and its declared type It returns the Signature from getZSignatureList().get(USED_CHANNELS_INDEX). It may throw a a UnsupportedAstClassException from getZSignatureList().
    
    Specified by:
    
    getUsedChannels in interface ActionSignature
  - setUsedChannels
```
public Signature setUsedChannels(Signature sig)
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It sets the given non-null (possibly empty) signature of used channels for this action signature. This contains the channel name and its declared type It is the same as getZSignatureList().set(USED_CHANNELS_INDEX, sig). The result is the old value previously stored (if any).
    
    Specified by:
    
    setUsedChannels in interface ActionSignature
  - getUsedCommunications
```
public CircusCommunicationList getUsedCommunications()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It represents the non-null (possibly empty) list of used channels within the communications of this action. This includes generic, implicit, or normal communications. It may throw a UnsupportedAstClassException from getCommunicationList().
    
    Specified by:
    
    getUsedCommunications in interface ActionSignature
  - getUsedChannelSets
```
public CircusChannelSetList getUsedChannelSets()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It represents the non-null (possibly empty) list of used channel sets within the name sets of this action. It may throw a UnsupportedAstClassException from getChannelSetListList().
    
    Specified by:
    
    getUsedChannelSets in interface ActionSignature
  - getUsedNameSets
```
public CircusNameSetList getUsedNameSets()
```
    Description copied from interface: ActionSignature
    
    This is a convenience method. It represents the non-null (possibly empty) list of used name sets within the name sets of this action. It may throw a UnsupportedAstClassException from getNameSetListList().
    
    Specified by:
    
    getUsedNameSets in interface ActionSignature

Class ActionSignatureImpl

Field Summary

Fields inherited from interface net.sourceforge.czt.circus.ast.ActionSignature

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.czt.circus.impl.CircusSignatureImpl

Methods inherited from class net.sourceforge.czt.base.impl.TermImpl

Methods inherited from class java.lang.Object

Methods inherited from interface net.sourceforge.czt.circus.ast.CircusSignature

Methods inherited from interface net.sourceforge.czt.base.ast.Term

Constructor Detail

ActionSignatureImpl

ActionSignatureImpl

Method Detail

countingFinaliser

instancesFinalised

equals

hashCode

accept

create

getChildren

instanceCount

getSignatureList

setSignatureList

getCommunicationList

setCommunicationList

getChannelSetList

setChannelSetList

getNameSetList

setNameSetList

getActionName

getActionZName

setActionName

isParamAction

getZSignatureList

getFormalParams

setFormalParams

getLocalVars

setLocalVars

getUsedChannels

setUsedChannels

getUsedCommunications

getUsedChannelSets

getUsedNameSets