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

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

java.util.Collection getAttributeNames()
Returns all tag attribute names, in the order they occur in the source.

Returns:
The Parameters value

getName

java.lang.String getName()
Returns the full name of the tag, excluding the @

Returns:
Describe the return value

getValue

java.lang.String getValue()
Returns the full value of the tag.

Returns:
Describe the return value

getDoc

XDoc getDoc()
Returns the XDoc object we belong to.

Returns:
the XDoc object we belong to.

getLineNumber

int getLineNumber()

getInfo

java.lang.String getInfo()

setAttribute

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

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

addTagListener

void addTagListener(XTagListener tagListener)

removeTagListener

void removeTagListener(XTagListener tagListener)

equals

boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

int hashCode()
Overrides:
hashCode in class java.lang.Object

validate

void validate()
              throws TagValidationException
Validates the tag.

Throws:
TagValidationException - if the content of the tag is somehow invalid