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

Class IrDocBlock

java.lang.Object

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

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

All Implemented Interfaces:

IrDocElement, IrDocFragment, Serializable

public class IrDocBlock
extends AbstractIrDocElement
implements IrDocFragment

Represents blocks in IrDocComment.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IrDocBlock() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(IrDocElementVisitor<R,P> visitor, P context) Accepts and calls back the visitor.
boolean	equals(Object obj)
List<? extends IrDocFragment>	getFragments() Returns the element fragments.
IrDocElementKind	getKind() Returns the element kind.
String	getTag() Returns the block tag.
int	hashCode()
void	setFragments(List<? extends IrDocFragment> fragments) Sets the element fragments.
void	setTag(String tag) Sets the block tag.
String	toString()

Methods inherited from class com.asakusafw.utils.java.internal.parser.javadoc.ir.AbstractIrDocElement

getLocation, setLocation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.asakusafw.utils.java.internal.parser.javadoc.ir.IrDocElement

getLocation, setLocation

Constructor Detail

IrDocBlock

public IrDocBlock()

Creates a new instance.

Method Detail

getKind

public IrDocElementKind getKind()

Description copied from interface: IrDocElement

Returns the element kind.

Specified by:

getKind in interface IrDocElement

Returns:

the element kind

getTag

public String getTag()

Returns the block tag. If the block tag exists, the returned text always start with @.

Returns:

the tag name (it starts with @), or null if this block has no tags

setTag

public void setTag(String tag)

Sets the block tag.

Parameters:

tag - the tag name (it may or may not start with @), or null if this block has no tags

getFragments

public List<? extends IrDocFragment> getFragments()

Returns the element fragments.

Returns:

the element fragments

setFragments

public void setFragments(List<? extends IrDocFragment> fragments)

Sets the element fragments.

Parameters:

fragments - the element fragments

Throws:

IllegalArgumentException - if the parameter is null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

accept

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

Description copied from interface: IrDocElement

Accepts and calls back the visitor.

Specified by:

accept in interface IrDocElement

Type Parameters:

R - type of visitor result

P - type of visitor context

Parameters:

visitor - the visitor to call back

context - the visitor context

Returns:

call back result