net.sourceforge.czt.base.impl

Class TermImpl

java.lang.Object

net.sourceforge.czt.base.impl.TermImpl

All Implemented Interfaces:

Term

public abstract class TermImpl
extends Object
implements Term

An abstract implementation of the interface Term.

Author:

Petra Malik

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TermImpl()
protected	TermImpl(BaseFactory factory)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(Visitor<R> v) Accepts a visitor.
int	annsSize() Returns whether the annotation list size.
boolean	equals(Object obj)
<T> T	getAnn(Class<T> aClass) Returns one of the aClass annotations of this term, or null if the term does not contain an annotation of this type.
List<Object>	getAnns() Returns a list of annotations.
BaseFactory	getFactory()
boolean	hasAnn() Returns true when annsSize() has more than zero elements.
<T> boolean	hasAnn(Class<T> aClass) Checks whether the term has any annotation of the given class type
int	hashCode()
<T> void	removeAnn(Class<T> aClass) Removes all annotations of the specific class.
<T> boolean	removeAnn(T annotation) Removes a specific annotation, if present.
String	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

create, getChildren

Constructor Detail

TermImpl

protected TermImpl()

TermImpl

protected TermImpl(BaseFactory factory)

Method Detail

getFactory

public BaseFactory getFactory()

accept

public <R> R accept(Visitor<R> v)

Description copied from interface: Term

Accepts a visitor.

This method provides support for the visitor design pattern. Depending on the kind of visitor interfaces the given visitor implements, the visited term chooses the visit-method which fits best and returns the object that a call to this method returns.

Specified by:

accept in interface Term

Parameters:

v - the visitor that wants to visit this term.

Returns:

the object which is returned by the visit-method call of the given visitor.

See Also:

net.sourceforge.czt.base.visitor

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getAnns

public List<Object> getAnns()

Description copied from interface: Term

Returns a list of annotations.

To add or remove elements, use the methods provided by the List interface (that's why there is no need for a setter method).

Avoid calling this method directly and prefer to check with hasAnn() first. This delays creation of underlying arrays and lead to considerable memory optimisation on large specs.

Specified by:

getAnns in interface Term

Returns:

a list of annotations (should never be null).

annsSize

public int annsSize()

Description copied from interface: Term

Returns whether the annotation list size. This method is useful to check whether to create underlying structure or not (e.g., getAnns() creates objects if null initially). This delayed instantiation saves considerable memory on large ASTs.

Specified by:

annsSize in interface Term

Returns:

size of annotation list or getAnns().size(). If 0, no array is created.

hasAnn

public boolean hasAnn()

Description copied from interface: Term

Returns true when annsSize() has more than zero elements.

Specified by:

hasAnn in interface Term

Returns:

getAnn

public <T> T getAnn(Class<T> aClass)

Description copied from interface: Term

Returns one of the aClass annotations of this term, or null if the term does not contain an annotation of this type.

Specified by:

getAnn in interface Term

Returns:

hasAnn

public <T> boolean hasAnn(Class<T> aClass)

Description copied from interface: Term

Checks whether the term has any annotation of the given class type

Specified by:

hasAnn in interface Term

Type Parameters:

T - type of annotation class

Parameters:

aClass - class to check

Returns:

whether there is an annotation of that kind or not

removeAnn

public <T> void removeAnn(Class<T> aClass)

Description copied from interface: Term

Removes all annotations of the specific class.

Specified by:

removeAnn in interface Term

Type Parameters:

T - type of annotation

Parameters:

aClass - class to check

removeAnn

public <T> boolean removeAnn(T annotation)

Description copied from interface: Term

Removes a specific annotation, if present. If there are more than one instance of T, the first one is removed. That is, the underlying annotations as returned by getAnns() are checked in order using a.equals(annotation)

Specified by:

removeAnn in interface Term

Type Parameters:

T - type of annotation

Parameters:

annotation - instance to remove

Returns:

whether the given ann has been removed or not

toString

public String toString()

Overrides:

toString in class Object