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

Class DocBlockImpl

java.lang.Object

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

All Implemented Interfaces:

DocBlock, DocElement, Model

public final class DocBlockImpl
extends Object
implements DocBlock

An implementation of DocBlock.

Constructor Summary

Constructors

Constructor and Description
DocBlockImpl()

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 DocElement>	getElements() Returns the inline elements.
ModelKind	getModelKind() Returns ModelKind.DOC_BLOCK which represents this element kind.
String	getTag() Returns the tag name.
int	hashCode() Returns the hash code of this model object.
<T> void	putModelTrait(Class<T> traitClass, T traitObject) Puts a model trait.
void	setElements(List<? extends DocElement> elements) Sets the inline elements.
void	setTag(String tag) Sets the tag text.
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

DocBlockImpl

public DocBlockImpl()

Method Detail

getTag

public String getTag()

Description copied from interface: DocBlock

Returns the tag name.

Specified by:

getTag in interface DocBlock

Returns:

the tag name

setTag

public void setTag(String tag)

Sets the tag text.

Parameters:

tag - the tag text

Throws:

IllegalArgumentException - if tag was null

getElements

public List<? extends DocElement> getElements()

Description copied from interface: DocBlock

Returns the inline elements.

Specified by:

getElements in interface DocBlock

Returns:

the inline elements

setElements

public void setElements(List<? extends DocElement> elements)

Sets the inline elements.

Parameters:

elements - the inline elements

Throws:

IllegalArgumentException - if elements was null

getModelKind

public ModelKind getModelKind()

Returns ModelKind.DOC_BLOCK which represents this element kind.

Specified by:

getModelKind in interface Model

Returns:

ModelKind.DOC_BLOCK

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