com.asakusafw.utils.java.internal.model.syntax

Class DocMethodImpl

java.lang.Object

com.asakusafw.utils.java.internal.model.syntax.DocMethodImpl

All Implemented Interfaces:

DocElement, DocMethod, Model

public final class DocMethodImpl
extends Object
implements DocMethod

An implementation of DocMethod.

Constructor Summary

Constructors

Constructor and Description
DocMethodImpl()

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 obj) 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.
List<? extends DocMethodParameter>	getFormalParameters() Returns the formal parameters.
ModelKind	getModelKind() Returns ModelKind.DOC_METHOD which represents this element kind.
SimpleName	getName() Returns the target method or constructor name.
Type	getType() Returns the owner type.
int	hashCode() Returns the hash code of this model object.
<T> void	putModelTrait(Class<T> traitClass, T traitObject) Puts a model trait.
void	setFormalParameters(List<? extends DocMethodParameter> formalParameters) Sets the formal parameter declarations.
void	setName(SimpleName name) Sets the target method or constructor name.
void	setType(Type type) Sets the owner type.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.asakusafw.utils.java.model.syntax.Model

equals, findModelTrait, hashCode, putModelTrait

Constructor Detail

DocMethodImpl

public DocMethodImpl()

Method Detail

getType

public Type getType()

Description copied from interface: DocMethod

Returns the owner type.

Specified by:

getType in interface DocMethod

Returns:

the owner type, or null if it is not specified

setType

public void setType(Type type)

Sets the owner type.

Parameters:

type - the owner type, or null if it is not specified

getName

public SimpleName getName()

Description copied from interface: DocMethod

Returns the target method or constructor name.

Specified by:

getName in interface DocMethod

Returns:

the target method or constructor name

setName

public void setName(SimpleName name)

Sets the target method or constructor name.

Parameters:

name - the target method or constructor name

Throws:

IllegalArgumentException - if name was null

getFormalParameters

public List<? extends DocMethodParameter> getFormalParameters()

Description copied from interface: DocMethod

Returns the formal parameters.

Specified by:

getFormalParameters in interface DocMethod

Returns:

the formal parameters

setFormalParameters

public void setFormalParameters(List<? extends DocMethodParameter> formalParameters)

Sets the formal parameter declarations.

Parameters:

formalParameters - the formal parameter declarations

Throws:

IllegalArgumentException - if formalParameters was null

getModelKind

public ModelKind getModelKind()

Returns ModelKind.DOC_METHOD which represents this element kind.

Specified by:

getModelKind in interface Model

Returns:

ModelKind.DOC_METHOD

accept

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

Description copied from interface: Model

Accepts the Visitor and processes this object in the visitor.

Specified by:

accept in interface Model

Type Parameters:

R - type of visitor result

C - type of visitor context

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

E extends Throwable

findModelTrait

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

Description copied from interface: Model

Returns a model trait for the specified type.

Specified by:

findModelTrait in interface Model

Type Parameters:

T - the trait type

Parameters:

traitClass - the trait type

Returns:

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

putModelTrait

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

Description copied from interface: Model

Puts a model trait.

Specified by:

putModelTrait in interface Model

Type Parameters:

T - the trait type

Parameters:

traitClass - the trait type

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

hashCode

public int hashCode()

Description copied from interface: Model

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

Specified by:

hashCode in interface Model

Overrides:

hashCode in class Object

Returns:

the hash code

equals

public boolean equals(Object obj)

Description copied from interface: Model

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

Specified by:

equals in interface Model

Overrides:

equals in class Object

Parameters:

obj - the target object

Returns:

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

toString

public String toString()

Overrides:

toString in class Object