xjavadoc
Interface XTag

All Known Implementing Classes:

DefaultXTag

public interface XTag

Author:

Aslak Hellesøy

Method Summary

void	addTagListener(XTagListener tagListener)
boolean	equals(java.lang.Object o)
java.util.Collection	getAttributeNames() Returns all tag attribute names, in the order they occur in the source.
java.lang.String	getAttributeValue(java.lang.String attributeName) Returns the value of the tag parameter with the given name, or null if none exist;
XDoc	getDoc() Returns the XDoc object we belong to.
java.lang.String	getInfo()
int	getLineNumber()
java.lang.String	getName() Returns the full name of the tag, excluding the @
java.lang.String	getValue() Returns the full value of the tag.
int	hashCode()
java.lang.String	removeAttribute(java.lang.String attributeName)
void	removeTagListener(XTagListener tagListener)
void	setAttribute(java.lang.String attributeName, java.lang.String attributeValue) Adds a parameter
void	validate() Validates the tag.

Method Detail

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String attributeName)

Returns the value of the tag parameter with the given name, or null if none exist;

Parameters:

attributeName - Describe what the parameter does

Returns:

The Parameter value

getAttributeNames

public java.util.Collection getAttributeNames()

Returns all tag attribute names, in the order they occur in the source.

Returns:

The Parameters value

getName

public java.lang.String getName()

Returns the full name of the tag, excluding the @

Returns:

Describe the return value

getValue

public java.lang.String getValue()

Returns the full value of the tag.

Returns:

Describe the return value

getDoc

public XDoc getDoc()

Returns the XDoc object we belong to.

Returns:

the XDoc object we belong to.

getLineNumber

public int getLineNumber()

getInfo

public java.lang.String getInfo()

setAttribute

public void setAttribute(java.lang.String attributeName,
                         java.lang.String attributeValue)

Adds a parameter

Parameters:

attributeName - name of the attribute

attributeValue - value of the attribute

removeAttribute

public java.lang.String removeAttribute(java.lang.String attributeName)

addTagListener

public void addTagListener(XTagListener tagListener)

removeTagListener

public void removeTagListener(XTagListener tagListener)

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

validate

public void validate()
              throws TagValidationException

Validates the tag.

Throws:

TagValidationException - if the content of the tag is somehow invalid