org.objectweb.kilim.description
Class NullElement

java.lang.Object
  extended byorg.objectweb.kilim.description.TemplateElementImpl
      extended byorg.objectweb.kilim.description.InlinedElement
          extended byorg.objectweb.kilim.description.NullElement
All Implemented Interfaces:
BasicElement, java.lang.Cloneable, TemplateElement

public class NullElement
extends InlinedElement

Author:
horn this class provides null providers and transformers ...

Field Summary
 
Fields inherited from class org.objectweb.kilim.description.InlinedElement
 
Fields inherited from class org.objectweb.kilim.description.TemplateElementImpl
 
Constructor Summary
NullElement(java.lang.String aName, int aStatus, boolean isP, boolean isT, TemplateDescription aTemplate)
          the public constructor of null elements.
 
Method Summary
 java.lang.Object clone()
          clones a template
 int getKind()
          returns the element kind.
 boolean isEventSource()
          indicates whether the element is an event source or not.
 boolean performsAction()
          Basic elements either provide values or exceute actions that complete the instatiation process This method.
 boolean providesValue()
          Basic elements either provide values or exceute actions that complete the instatiation process This method.
 
Methods inherited from class org.objectweb.kilim.description.InlinedElement
getLocalName, getStatus, setLocalName, setStatus
 
Methods inherited from class org.objectweb.kilim.description.TemplateElementImpl
getContainingTemplate, getTemplateDefHierarchy, setContainingTemplate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.objectweb.kilim.description.TemplateElement
getContainingTemplate, getTemplateDefHierarchy, setContainingTemplate
 

Constructor Detail

NullElement

public NullElement(java.lang.String aName,
                   int aStatus,
                   boolean isP,
                   boolean isT,
                   TemplateDescription aTemplate)
            throws KilimException
the public constructor of null elements. A null element is not considered as a property in Kilim since it can be used as a transformer.

Parameters:
aTemplate - : the template in which the element is declared.
aName - : the name of the element
aStatus - : the status of the element (should be one of KILIM.PUBLIC, KILIM.PROTECTED, KILIM.PRIVATE)
isP - is true when the element provides a value (it behaves like a provider)
isT - is true when the element performs an action (it behaves like a transformer)
Throws:
KilimException - :
Method Detail

getKind

public int getKind()
Description copied from interface: BasicElement
returns the element kind.

Returns:
int
See Also:
BasicElement.getKind()

providesValue

public boolean providesValue()
Description copied from interface: BasicElement
Basic elements either provide values or exceute actions that complete the instatiation process This method. indicates whether the element returns a value in the Kilim model. The result is true for providers, ports, properties, inlined getters inlined news, constructors, methods which do not return void. It also return true for references to the elements previously defined (i.e. ports, properties, .).

Specified by:
providesValue in interface BasicElement
Overrides:
providesValue in class InlinedElement
See Also:
org.objectweb.kilim.description.TemplateElement#provides?Value()

performsAction

public boolean performsAction()
Description copied from interface: BasicElement
Basic elements either provide values or exceute actions that complete the instatiation process This method. indicates whether the element performs an action and can therefore been used in a trigger. The result is true for transformers, inlined setter, inlined news, methods, and constructors. It also return true for references to the elements previously defined (setters, methods, ...).

Specified by:
performsAction in interface BasicElement
Overrides:
performsAction in class InlinedElement
See Also:
org.objectweb.kilim.description.TemplateElement#performsAction()

isEventSource

public boolean isEventSource()
Description copied from interface: BasicElement
indicates whether the element is an event source or not.

Specified by:
isEventSource in interface BasicElement
Overrides:
isEventSource in class InlinedElement
See Also:
BasicElement.isEventSource()

clone

public java.lang.Object clone()
Description copied from interface: TemplateElement
clones a template

Specified by:
clone in interface TemplateElement
Overrides:
clone in class TemplateElementImpl
See Also:
Object.clone()