com.asakusafw.utils.java.model.syntax

Interface Model

All Known Subinterfaces:

AlternateConstructorInvocation, Annotation, AnnotationDeclaration, AnnotationElement, AnnotationElementDeclaration, ArrayAccessExpression, ArrayCreationExpression, ArrayInitializer, ArrayType, AssertStatement, AssignmentExpression, Attribute, BasicType, Block, BlockComment, BranchStatement, BreakStatement, CastExpression, CatchClause, ClassBody, ClassDeclaration, ClassInstanceCreationExpression, ClassLiteral, Comment, CompilationUnit, ConditionalExpression, ConstructorDeclaration, ConstructorInvocation, ConstructorReferenceExpression, ContinueStatement, DocBlock, DocElement, DocField, DocMethod, DocMethodParameter, DocText, DoStatement, EmptyStatement, EnhancedForStatement, EnumConstantDeclaration, EnumDeclaration, Expression, ExpressionStatement, FieldAccessExpression, FieldDeclaration, ForInitializer, FormalParameterDeclaration, ForStatement, IfStatement, ImportDeclaration, InfixExpression, InitializerDeclaration, InstanceofExpression, InterfaceDeclaration, Invocation, Javadoc, Keyword, LabeledStatement, LambdaBody, LambdaExpression, LambdaParameter, LineComment, Literal, LocalClassDeclaration, LocalVariableDeclaration, MarkerAnnotation, MethodDeclaration, MethodInvocationExpression, MethodOrConstructorDeclaration, MethodOrConstructorReferenceExpression, MethodReferenceExpression, Modifier, Name, NamedType, NormalAnnotation, PackageDeclaration, ParameterizedType, ParenthesizedExpression, PostfixExpression, QualifiedName, QualifiedType, ReturnStatement, SimpleName, SingleElementAnnotation, Statement, StatementExpressionList, Super, SuperConstructorInvocation, SwitchCaseLabel, SwitchDefaultLabel, SwitchLabel, SwitchStatement, SynchronizedStatement, This, ThrowStatement, TryResource, TryStatement, Type, TypeBodyDeclaration, TypeDeclaration, TypedElement, TypeOrExpression, TypeParameterDeclaration, UnaryExpression, UnionType, VariableDeclarator, WhileStatement, Wildcard

All Known Implementing Classes:

AlternateConstructorInvocationImpl, AnnotationDeclarationImpl, AnnotationElementDeclarationImpl, AnnotationElementImpl, ArrayAccessExpressionImpl, ArrayCreationExpressionImpl, ArrayInitializerImpl, ArrayTypeImpl, AssertStatementImpl, AssignmentExpressionImpl, BasicTypeImpl, BlockCommentImpl, BlockImpl, BreakStatementImpl, CastExpressionImpl, CatchClauseImpl, ClassBodyImpl, ClassDeclarationImpl, ClassInstanceCreationExpressionImpl, ClassLiteralImpl, CompilationUnitImpl, ConditionalExpressionImpl, ConstructorDeclarationImpl, ConstructorReferenceExpressionImpl, ContinueStatementImpl, DocBlockImpl, DocFieldImpl, DocMethodImpl, DocMethodParameterImpl, DocTextImpl, DoStatementImpl, EmptyStatementImpl, EnhancedForStatementImpl, EnumConstantDeclarationImpl, EnumDeclarationImpl, ExpressionStatementImpl, FieldAccessExpressionImpl, FieldDeclarationImpl, FormalParameterDeclarationImpl, ForStatementImpl, IfStatementImpl, ImportDeclarationImpl, InfixExpressionImpl, InitializerDeclarationImpl, InstanceofExpressionImpl, InterfaceDeclarationImpl, JavadocImpl, LabeledStatementImpl, LambdaExpressionImpl, LineCommentImpl, LiteralImpl, LocalClassDeclarationImpl, LocalVariableDeclarationImpl, MarkerAnnotationImpl, MethodDeclarationImpl, MethodInvocationExpressionImpl, MethodReferenceExpressionImpl, ModifierImpl, NamedTypeImpl, NormalAnnotationImpl, PackageDeclarationImpl, ParameterizedTypeImpl, ParenthesizedExpressionImpl, PostfixExpressionImpl, QualifiedNameImpl, QualifiedTypeImpl, ReturnStatementImpl, SimpleNameImpl, SingleElementAnnotationImpl, StatementExpressionListImpl, SuperConstructorInvocationImpl, SuperImpl, SwitchCaseLabelImpl, SwitchDefaultLabelImpl, SwitchStatementImpl, SynchronizedStatementImpl, ThisImpl, ThrowStatementImpl, TryResourceImpl, TryStatementImpl, TypeParameterDeclarationImpl, UnaryExpressionImpl, UnionTypeImpl, VariableDeclaratorImpl, WhileStatementImpl, WildcardImpl

public interface Model

A root interface of all Java DOM objects.

Method Summary

Modifier and Type	Method and Description
<R,C,E extends Throwable> R	accept(Visitor<R,C,E> visitor, C context) Accepts the Visitor and processes this object in the visitor.
boolean	equals(Object other) Returns whether this object is equivalent to the specified object or not.
<T> T	findModelTrait(Class<T> traitClass) Returns a model trait for the specified type.
ModelKind	getModelKind() Returns the model kind.
int	hashCode() Returns the hash code of this model object.
<T> void	putModelTrait(Class<T> traitClass, T traitObject) Puts a model trait.

Method Detail

getModelKind

ModelKind getModelKind()

Returns the model kind.

Returns:

the model kind

accept

<R,C,E extends Throwable> R accept(Visitor<R,C,E> visitor,
                                   C context)
                            throws E extends Throwable

Accepts the Visitor and processes this object in the visitor.

Type Parameters:

C - type of visitor context

R - type of visitor result

E - type of visitor exception

Parameters:

visitor - the target visitor

context - the current context (nullable)

Returns:

the processing result

Throws:

E - if error occurred while processing this object in the visitor

IllegalArgumentException - if visitor is null

E extends Throwable

hashCode

int hashCode()

Returns the hash code of this model object. Note that, any traits does not have any effects to the hash code.

Overrides:

hashCode in class Object

Returns:

the hash code

equals

boolean equals(Object other)

Returns whether this object is equivalent to the specified object or not. Note that, any traits does not have any effects to the equivalence.

Overrides:

equals in class Object

Parameters:

other - the target object

Returns:

true if this object is equivalent to the specified object, otherwise false

findModelTrait

<T> T findModelTrait(Class<T> traitClass)

Returns a model trait for the specified type.

Type Parameters:

T - the trait type

Parameters:

traitClass - the trait type

Returns:

the corresponded trait, or null if there is no such a trait

Throws:

IllegalArgumentException - if the parameter is null

putModelTrait

<T> void putModelTrait(Class<T> traitClass,
                       T traitObject)

Puts a model trait.

Type Parameters:

T - the trait type

Parameters:

traitClass - the trait type

traitObject - the trait object, or null to remove the target trait

Throws:

IllegalArgumentException - if traitClass is null