BasicProcessImpl (CZT Corejava Circus 1.6-SNAPSHOT API)

java.lang.Object
- net.sourceforge.czt.base.impl.TermImpl
- - net.sourceforge.czt.circus.impl.CircusProcessImpl
  - - net.sourceforge.czt.circus.impl.BasicProcessImpl

All Implemented Interfaces:

Term, BasicProcess, CircusProcess
```
public class BasicProcessImpl
extends CircusProcessImpl
implements BasicProcess
```
An implementation of the interface BasicProcess.

Author:

GnAST version 1.6-SNAPSHOT

Constructor Summary

Constructors
Modifier Constructor and Description

protected BasicProcessImpl()
The default constructor.

protected BasicProcessImpl(BaseFactory factory)

Constructors
Modifier	Constructor and Description
`protected`	`BasicProcessImpl()` The default constructor.
`protected`	`BasicProcessImpl(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 BasicProcessImpl (e.g., ic >= sl)
`BasicProcessImpl`	`create(Object[] args)` Returns a new object of this class.
`boolean`	`equals(Object obj)` Compares the specified object with this BasicProcessImpl for equality.
`Object[]`	`getChildren()`
`List<? extends Para>`	`getLocalPara()` This is a convenience method.
`CircusAction`	`getMainAction()` This is a convenience method.
`List<? extends Para>`	`getOnTheFlyPara()` This is a convenience method.
`ParaList`	`getParaList()` Returns the ParaList element.
`AxPara`	`getStatePara()` This is a convenience method.
`Name`	`getStateParaName()` This is a convenience method.
`ZName`	`getStateParaZName()` This is a convenience method.
`ZParaList`	`getZParaList()` This is a convenience method.
`int`	`hashCode()` Returns the hash code value for this BasicProcessImpl.
`static long`	`instanceCount()` Only concrete classes get the instance count method visible
`static long`	`instancesFinalised()`
`boolean`	`isDefaultState()` Returns true iff getStatePara() != null and the result is the default state paragraph as created by the parser.
`boolean`	`isMainActionValid()`
`boolean`	`isStateValid()` This method checks whether the state paragraph is valid.
`void`	`setParaList(ParaList paraList)` Sets the ParaList element.

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.base.ast.Term
annsSize, getAnn, getAnns, hasAnn, hasAnn, removeAnn, removeAnn

- Constructor Detail
  - BasicProcessImpl
```
protected BasicProcessImpl()
```
    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.
  - BasicProcessImpl
```
protected BasicProcessImpl(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 BasicProcessImpl (e.g., ic >= sl)
  - instancesFinalised
```
public static long instancesFinalised()
```
  - equals
```
public boolean equals(Object obj)
```
    Compares the specified object with this BasicProcessImpl for equality. Returns true if and only if the specified object is also a(n) BasicProcessImpl and all the getter methods except getAnns return equal objects.
    
    Overrides:
    
    equals in class CircusProcessImpl
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this BasicProcessImpl.
    
    Overrides:
    
    hashCode in class CircusProcessImpl
  - accept
```
public <R> R accept(Visitor<R> v)
```
    Accepts a visitor.
    
    Specified by:
    
    accept in interface Term
    
    Overrides:
    
    accept in class CircusProcessImpl
  - create
```
public BasicProcessImpl 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
  - getParaList
```
public ParaList getParaList()
```
    Description copied from interface: BasicProcess
    
    Returns the ParaList element.
    
    Specified by:
    
    getParaList in interface BasicProcess
    
    Returns:
    
    the ParaList element.
  - setParaList
```
public void setParaList(ParaList paraList)
```
    Description copied from interface: BasicProcess
    
    Sets the ParaList element.
    
    Specified by:
    
    setParaList in interface BasicProcess
    
    Parameters:
    
    paraList - the ParaList element.
    
    See Also:
    
    BasicProcess.getParaList()
  - getZParaList
```
public ZParaList getZParaList()
```
    Description copied from interface: BasicProcess
    
    This is a convenience method. It represents the non-null (possibly empty) list of paragraphs for the basic process. It contains both Z and Circus paragraphs. It may throw a UnsupportedAstClassException is #getParaList() is a ParaJoker. This method forms a partition between getOnTheFlyPara() and getLocalPara(). All these invariants are guaranteed by both the parser and typechecker.
    
    Specified by:
    
    getZParaList in interface BasicProcess
  - getStatePara
```
public AxPara getStatePara()
```
    Description copied from interface: BasicProcess
    
    This is a convenience method. It returns the state paragraph within the getZParaList(). That is, the first paragraph with a CircusStateAnn. A state paragraph is always a horizonal AxPara. When declared implicitly a default name is given with the prefix CircusUtils.DEFAULT_PROCESS_STATE_NAME.
    
    Specified by:
    
    getStatePara in interface BasicProcess
  - isStateValid
```
public boolean isStateValid()
```
    Description copied from interface: BasicProcess
    
    This method checks whether the state paragraph is valid. That is, if getStatePara() != null and that getZParaList() contains exactly one state element. The parser always creates a default state for basic process declared without state. So, after parsing, this method should always be true. It may be false when the parser is still creating the underlying structures, or when created manually by the user.
    
    Specified by:
    
    isStateValid in interface BasicProcess
  - isDefaultState
```
public boolean isDefaultState()
```
    Description copied from interface: BasicProcess
    
    Returns true iff getStatePara() != null and the result is the default state paragraph as created by the parser. The default state paragraph is empty (i.e., horizontal box named CircusUtils.DEFAULT_PROCESS_STATE_NAME. with empty declarations and true predicate).
    
    Specified by:
    
    isDefaultState in interface BasicProcess
    
    Returns:
  - getMainAction
```
public CircusAction getMainAction()
```
    Description copied from interface: BasicProcess
    
    This is a convenience method. It returns the main action within the getZParaList(). The method checks that only one such paragraph exists, that it has a OnTheFlyAnn in it, and that its name is CircusUtils.DEFAULT_MAIN_ACTION_NAME. All these invariants are guaranteed by both the parser and typechecker.
    
    Specified by:
    
    getMainAction in interface BasicProcess
  - isMainActionValid
```
public boolean isMainActionValid()
```
    Specified by:
    
    isMainActionValid in interface BasicProcess
  - getLocalPara
```
public List<? extends Para> getLocalPara()
```
    Description copied from interface: BasicProcess
    
    This is a convenience method. It returns a unmodifiable list of declared paragraphs within the getZParaList(); they may be either Circus or Z paragraphs. That is, all paragraphs from getZParaList() that have not been declared on-the-fly. All these invariants are guaranteed by both the parser and typechecker.
    
    Specified by:
    
    getLocalPara in interface BasicProcess
  - getOnTheFlyPara
```
public List<? extends Para> getOnTheFlyPara()
```
    Description copied from interface: BasicProcess
    
    This is a convenience method. It returns a unmodifiable list of on-the-fly paragraphs within the getZParaList(); they can only be ActionPara, since there are no Z on-the-fly paragraphs. That is, all paragraphs from getZParaList() that have been declared on-the-fly. All elements in the resulting list contain a OnTheFlyAnn. All these invariants are guaranteed by both the parser and typechecker.
    
    Specified by:
    
    getOnTheFlyPara in interface BasicProcess
  - getStateParaName
```
public Name getStateParaName()
```
    Description copied from interface: BasicProcess
    
    This is a convenience method. It represents the non-null name of the (possibly implicitly) declared process state name.
    
    Specified by:
    
    getStateParaName in interface BasicProcess
  - getStateParaZName
```
public ZName getStateParaZName()
```
    Description copied from interface: BasicProcess
    
    This is a convenience method. It casts getStateParaName() into a ZName.
    
    Specified by:
    
    getStateParaZName in interface BasicProcess

Class BasicProcessImpl

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicProcessImpl

BasicProcessImpl

Method Detail

countingFinaliser

instancesFinalised

equals

hashCode

accept

create

getChildren

instanceCount

getParaList

setParaList

getZParaList

getStatePara

isStateValid

isDefaultState

getMainAction

isMainActionValid

getLocalPara

getOnTheFlyPara

getStateParaName

getStateParaZName