StatefulModule (QDL root module 1.6.0 API)

java.lang.Object
- org.qdl_lang.module.Module
- - org.qdl_lang.extensions.JavaModule
  - - org.qdl_lang.extensions.examples.stateful.StatefulModule

All Implemented Interfaces:

Serializable, Cloneable, XThing
```
public class StatefulModule
extends JavaModule
```
See Also:

Serialized Form

Field Summary
- Fields inherited from class org.qdl_lang.extensions.JavaModule
  funcs, vars
- Fields inherited from class org.qdl_lang.module.Module
  FDOC_CONVERT

Constructor Summary

Constructors
Constructor Description

StatefulModule()

StatefulModule(URI namespace)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`getDescription()`	The `JavaModule.createDefaultDocs()` will create basic documentation for functions and such, and is called automatically during module `JavaModule.init(State)`, but the actual description of this module -- if any -- is done here.
`Module`	`newInstance(State state)`	Modules are effectively templates.

Methods inherited from class org.qdl_lang.extensions.JavaModule
addFunctions, addVariables, createDefaultDocs, deserializeFromJSON, deserializeStates, getClassname, getDocumentation, getListByTag, getLoaderClassName, getMetaClass, hasMetaClass, init, init, isExternal, serializeToJSON, setClassName, setDocumentation, setLoaderClassName, setMetaClass, toString, writeExtraXMLAttributes

Methods inherited from class org.qdl_lang.module.Module
fromJSON, fromXML, fromXML, getAlias, getId, getInheritMode, getKey, getListByTag, getMTKey, getName, getNamespace, getParentInstanceAlias, getParentInstanceID, getParentTemplateID, getState, isTemplate, isUsed, readExtraXMLAttributes, readExtraXMLElements, setAlias, setId, setInheritanceMode, setNamespace, setParentInstanceAlias, setParentInstanceID, setParentTemplateID, setState, setTemplate, setupModule, setUsed, toJSON, toXML, toXML, toXML2, writeExtraXMLElements

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

- Constructor Detail
  - StatefulModule
```
public StatefulModule(URI namespace)
```
  - StatefulModule
```
public StatefulModule()
```
- Method Detail
  - newInstance
```
public Module newInstance(State state)
```
    Description copied from class: Module
    
    Modules are effectively templates. This passes in the state of the parser at the point a new module is required and the contract is to create a new instance of this module with the state. Note that the state passed in may have nothing to do with the state here. You are creating a new module for the given state using this as a template.
    
    All implementations should gracefully handle a null state with the assumption that the full state will be set later. This is because of bootstrapping networks of modules during deserialization.
    
    Specified by:
    
    newInstance in class Module
    
    Returns:
  - getDescription
```
public List<String> getDescription()
```
    Description copied from class: JavaModule
    
    The JavaModule.createDefaultDocs() will create basic documentation for functions and such, and is called automatically during module JavaModule.init(State), but the actual description of this module -- if any -- is done here. Override and return your description.
    
    Overrides:
    
    getDescription in class JavaModule
    
    Returns: