org.japano.metadata
Interface MetadataTag

All Known Implementing Classes:

AnnotationTag, JavadocTag

public interface MetadataTag

Common interface to metadata tags for xjavadoc and annotation metadata.

Version:

$Id: MetadataTag.java,v 1.8 2005/09/27 21:30:51 fforw Exp $

Author:

Sven Helmberger ( sven dot helmberger at gmx dot de )

Method Summary

void	error(java.lang.String message) Generates an error message with this tag's start as error position.
java.lang.String	getAttribute(java.lang.String name) Returns the tag attribute value with the given name or null if no such attribute is set.
java.lang.String[]	getAttributes(java.lang.String name) Returns the tag attribute value with the given name or null if no such attribute is set.
MetadataTag	getSibling(TagType type) Returns the first sibling of the given type.
java.util.List	getSiblings(TagType type) Returns a list with siblings of this tag of the given type.
TagType	getType() Returns the japano tag type for this metadata tag.

Method Detail

getAttribute

java.lang.String getAttribute(java.lang.String name)

Returns the tag attribute value with the given name or null if no such attribute is set.

Parameters:

name - attribute name

Returns:

value or null

getAttributes

java.lang.String[] getAttributes(java.lang.String name)

Returns the tag attribute value with the given name or null if no such attribute is set.

Parameters:

name - attribute name

Returns:

value or null

getSiblings

java.util.List getSiblings(TagType type)

Returns a list with siblings of this tag of the given type.

Parameters:

type - tag type

Returns:

list

getSibling

MetadataTag getSibling(TagType type)

Returns the first sibling of the given type.

Parameters:

type - tag type

Returns:

list

error

void error(java.lang.String message)

Generates an error message with this tag's start as error position.

getType

TagType getType()

Returns the japano tag type for this metadata tag.

Returns:

tag type

See Also:

TagType