org.objectweb.kilim.description
Class Transformer
java.lang.Object
org.objectweb.kilim.description.TemplateElementImpl
org.objectweb.kilim.description.BasicNamedElementImpl
org.objectweb.kilim.description.Transformer
- All Implemented Interfaces:
- BasicElement, BasicNamedElement, java.lang.Cloneable, NamedElement, TemplateElement
- public class Transformer
- extends BasicNamedElementImpl
- Author:
- horn
Constructor Summary |
Transformer(java.lang.String aName,
int aStatus,
boolean isP,
TemplateDescription aTemplate)
A public constructor to transformers. |
Transformer(java.lang.String aName,
int aStatus,
TemplateDescription aTemplate)
A public constructor to transformers (that cannot be used as a provider). |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
action
private BasicElement action
Transformer
public Transformer(java.lang.String aName,
int aStatus,
boolean isP,
TemplateDescription aTemplate)
throws KilimException
- A public constructor to transformers.
- Parameters:
aName
- : the name associated to the transformeraStatus
- : the status of the transformer. It should be one of KILIM.PUBLIC, KILIM.PROTECTED, KILIM.PRIVATE.isP
- : is true if the transformer can be used a a provider.aTemplate
- : the template in which the transformer has been declared.
- Throws:
KilimException
- : generated if aName or aTemplate is null, if aStatus has an illegal value.
Transformer
public Transformer(java.lang.String aName,
int aStatus,
TemplateDescription aTemplate)
throws KilimException
- A public constructor to transformers (that cannot be used as a provider). It is strictly equivalent to (aName, aStatus, false, true, aTemplate, aTemplate);
- Parameters:
aName
- : the name associated to the transformeraStatus
- : the status of the transformer. It should be one of KILIM.PUBLIC, KILIM.PROTECTED, KILIM.PRIVATE.aTemplate
- : the template in which the transformer has been declared.
- Throws:
KilimException
- : generated if aName or aTemplate is null, if aStatus has an illegal value.
getKind
public int getKind()
- Description copied from interface:
BasicElement
- returns the element kind.
- Returns:
- int
- See Also:
BasicElement.getKind()
setAction
public void setAction(BasicElement aAction)
throws KilimException
- sets the action (i.e. the effective mechanism represented by the transformer).
- Parameters:
aAction
- : the action to be performed by the transformer.
- Throws:
KilimException
- : generated if aAction is null or if aAction has not been created as an element able to perform action.
getAction
public BasicElement getAction()
throws KilimException
- returns the action (i.e. the effective mechanism represented by the transformer).
- Returns:
- InlinedElement. The action associated to the transformer.
- Throws:
KilimException
- : it is never generated.
setLocalName
public void setLocalName(java.lang.String aName)
throws KilimException
- Description copied from interface:
NamedElement
- sets a name to the element.
- Specified by:
setLocalName
in interface NamedElement
- Overrides:
setLocalName
in class BasicNamedElementImpl
- Throws:
KilimException
- See Also:
org.objectweb.kilim.description.TemplateElement#setLocalName(String)
setStatus
public void setStatus(int aStatus)
throws KilimException
- Description copied from interface:
NamedElement
- sets the element status.
- Specified by:
setStatus
in interface NamedElement
- Overrides:
setStatus
in class BasicNamedElementImpl
- Throws:
KilimException
- See Also:
org.objectweb.kilim.description.TemplateElement#setStatus(int)