de.intarsys.tools.functor

Class DeclarationElement

java.lang.Object

de.intarsys.tools.functor.Declaration

de.intarsys.tools.functor.DeclarationElement

All Implemented Interfaces:

IDeclaration, IDeclarationElement

Direct Known Subclasses:

ArgumentDeclaration

public abstract class DeclarationElement
extends Declaration
implements IDeclarationElement

A common superclass for IDeclarationElement instances. This one has a very simple implementation for modifiers. Only the presence of the modifier string fragment in declared modifier string is checked.

Field Summary

Fields inherited from interface de.intarsys.tools.functor.IDeclarationElement

MOD_TRANSIENT

Constructor Summary

Constructors

Constructor and Description
DeclarationElement(Object declarationContext, String name, String modifiers)
DeclarationElement(Object declarationContext, String name, String modifiers, String description)

Method Summary

Methods

Modifier and Type	Method and Description
void	addModifier(String modifier)
String	getDescription()
String[]	getModifiers()
String	getModifierString() The string representation of all modifiers set.
String	getName() An optional name for the declaration element.
boolean	hasModifier(String modifier) true if the declaration has the requested modifier.
void	setDescription(String description)
void	setModifierString(String modifierString)
void	setName(String name)
String	toString()
static boolean	validateName(String name)
static boolean	validatePath(String name)

Methods inherited from class de.intarsys.tools.functor.Declaration

getDeclarationContext, isBlock

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.intarsys.tools.functor.IDeclaration

copy, getDeclarationContext, isBlock

Constructor Detail

DeclarationElement

public DeclarationElement(Object declarationContext,
                  String name,
                  String modifiers)

DeclarationElement

public DeclarationElement(Object declarationContext,
                  String name,
                  String modifiers,
                  String description)

Method Detail

validateName

public static boolean validateName(String name)

validatePath

public static boolean validatePath(String name)

addModifier

public void addModifier(String modifier)

getDescription

public String getDescription()

getModifiers

public String[] getModifiers()

getModifierString

public String getModifierString()

Description copied from interface: IDeclarationElement

The string representation of all modifiers set.

Specified by:

getModifierString in interface IDeclarationElement

Returns:

getName

public String getName()

Description copied from interface: IDeclarationElement

An optional name for the declaration element.

Specified by:

getName in interface IDeclarationElement

Returns:

An optional name for the declaration element.

hasModifier

public boolean hasModifier(String modifier)

Description copied from interface: IDeclarationElement

true if the declaration has the requested modifier.

An implementation is free to support modifiers and define their respective semantics.

An example for a modifier may be "persistent" to indicate the implementation should store argument values to be able to present them again in a later call (in a wizard for example).

Specified by:

hasModifier in interface IDeclarationElement

Parameters:

modifier - The modifier name.

Returns:

true if the declaration has the requested modifier.

setDescription

public void setDescription(String description)

setModifierString

public void setModifierString(String modifierString)

setName

public void setName(String name)

toString

public String toString()

Overrides:

toString in class Object