com.asakusafw.utils.java.internal.parser.javadoc.ir

Interface IrDocElement

All Known Subinterfaces:

IrDocFragment, IrDocType

All Known Implementing Classes:

AbstractIrDocElement, IrDocArrayType, IrDocBasicType, IrDocBlock, IrDocComment, IrDocField, IrDocMember, IrDocMethod, IrDocMethodParameter, IrDocName, IrDocNamedType, IrDocQualifiedName, IrDocSimpleName, IrDocText

public interface IrDocElement

An abstract super interface of elements in (Java documentation comments).

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(IrDocElementVisitor<R,P> visitor, P context) Accepts and calls back the visitor.
IrDocElementKind	getKind() Returns the element kind.
IrLocation	getLocation() Returns the location where this element appears.
void	setLocation(IrLocation location) Sets the location where this element appears.

Method Detail

getKind

IrDocElementKind getKind()

Returns the element kind.

Returns:

the element kind

getLocation

IrLocation getLocation()

Returns the location where this element appears.

Returns:

the location where this element appears, or null if it is not specified

setLocation

void setLocation(IrLocation location)

Sets the location where this element appears.

Parameters:

location - the location, or null to unset it

accept

<R,P> R accept(IrDocElementVisitor<R,P> visitor,
               P context)

Accepts and calls back the visitor.

Type Parameters:

P - type of visitor context

R - type of visitor result

Parameters:

context - the visitor context

visitor - the visitor to call back

Returns:

call back result

Throws:

IllegalArgumentException - if visitor was null