Class UMLElement

java.lang.Object

org.tquadrat.foundation.javadoc.umlgraph.UMLElement

All Implemented Interfaces:

AnnotatedConstruct, Element

Direct Known Subclasses:

UMLMemberElement, UMLTypeElement

@ClassVersion(sourceVersion="$Id: UMLElement.java 1282 2026-09-08 23:52:53Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public abstract sealed class UMLElement
extends Object
implements Element
permits UMLMemberElement, UMLTypeElement

The wrapper for an Element instance, enhanced by information needed for the creation of the UML graph.

Author:

Thomas Thrien - thomas.thrien@tquadrat.org

Version:

$Id: UMLElement.java 1282 2026-09-08 23:52:53Z tquadrat $

Since:

0.0.5

Field Summary

Fields

Modifier and Type	Field	Description
private final Element	m_Wrapped	The wrapped element.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UMLElement(Element element)	Creates a new UMLElement instance.

Method Summary

Modifier and Type	Method	Description
final <R,P> R	accept(ElementVisitor<R,P> visitor, P payload)
final TypeMirror	asType()
final <A extends Annotation> A	getAnnotation(Class<A> annotationType)
final List<? extends AnnotationMirror>	getAnnotationMirrors()
final <A extends Annotation> A[]	getAnnotationsByType(Class<A> annotationType)
final List<? extends Element>	getEnclosedElements()
Element	getEnclosingElement()
final ElementKind	getKind()
final Set<Modifier>	getModifiers()
final Name	getSimpleName()
static final boolean	isAPI(Element element)	Tests whether the given element is part of an API or not.
static final boolean	isAttribute(Element element)	Tests whether the given element represents a field.
static final boolean	isConstructor(Element element)	Tests whether the given element represents a constructor.
static final boolean	isMethod(Element element)	Tests whether the given element represents a method.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Element

equals, hashCode

Field Details

m_Wrapped

private final Element m_Wrapped

The wrapped element.

Constructor Details

UMLElement

protected UMLElement(Element element)

Creates a new UMLElement instance.

Parameters:

element - The wrapped element.

Method Details

accept

public final <R,P> R accept(ElementVisitor<R,P> visitor,
 P payload)

Specified by:

accept in interface Element

asType

public final TypeMirror asType()

Specified by:

asType in interface Element

getAnnotation

public final <A extends Annotation> A getAnnotation(Class<A> annotationType)

Specified by:

getAnnotation in interface AnnotatedConstruct

Specified by:

getAnnotation in interface Element

getAnnotationsByType

public final <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationType)

Specified by:

getAnnotationsByType in interface AnnotatedConstruct

Specified by:

getAnnotationsByType in interface Element

getAnnotationMirrors

public final List<? extends AnnotationMirror> getAnnotationMirrors()

Specified by:

getAnnotationMirrors in interface AnnotatedConstruct

Specified by:

getAnnotationMirrors in interface Element

getEnclosedElements

public final List<? extends Element> getEnclosedElements()

Specified by:

getEnclosedElements in interface Element

getEnclosingElement

public Element getEnclosingElement()

Specified by:

getEnclosingElement in interface Element

getKind

public final ElementKind getKind()

Specified by:

getKind in interface Element

getModifiers

public final Set<Modifier> getModifiers()

Specified by:

getModifiers in interface Element

getSimpleName

public final Name getSimpleName()

Specified by:

getSimpleName in interface Element

isAPI

public static final boolean isAPI(Element element)

Tests whether the given element is part of an API or not. The consideration is, that only element that are either public or protected are part of the API of a class.

Parameters:

element - The element to test.

Returns:

true if the element is part of the API, false otherwise.

isAttribute

public static final boolean isAttribute(Element element)

Tests whether the given element represents a field.

Parameters:

element - The element to test.

Returns:

true if the element represents a field (but not an enum value constant), false otherwise.

isConstructor

public static final boolean isConstructor(Element element)

Tests whether the given element represents a constructor.

Parameters:

element - The element to test.

Returns:

true if the element represents a constructor, false otherwise.

isMethod

public static final boolean isMethod(Element element)

Tests whether the given element represents a method.

Parameters:

element - The element to test.

Returns:

true if the element represents a method, false otherwise.