com.ibm.dse.tools.workbench.base
Interface Tag

All Known Implementing Classes:
DefaultTag

public interface Tag

A tag must be able to give its name, its list of attributes and its composition.


Method Summary
 void addAttribute(TagAttribute anAttribute)
          Adds an attribute to the list of attributes.
 void addSubTag(Tag aSubTag)
          Adds a subTag to the tag.
 TagAttribute[] getAttrList()
          Returns a list of attributes.
 java.lang.String getName()
          Returns the name of the tag.
 Tag[] getSubTags()
          Returns the list of subtags.
 boolean isAComposedTag()
          Indicates whether the Tag is a composed tag or a simple tag.
 void setAttrList(TagAttribute[] aAttrList)
          Sets the list of attributes.
 void setName(java.lang.String aName)
          Sets the name of the tag.
 void setSubTagAt(Tag aSubTag, int index)
          Sets the subTag at the specified index of the list of subTags.
 void setSubTags(Tag[] someSubTags)
          Sets the list of subtags.
 

Method Detail

addAttribute

public void addAttribute(TagAttribute anAttribute)
Adds an attribute to the list of attributes.
Parameters:
anAttribute - com.ibm.dse.tools.workbench.base.TagAttribute

addSubTag

public void addSubTag(Tag aSubTag)
Adds a subTag to the tag.
Parameters:
aSubTag - com.ibm.dse.base.Tag

getAttrList

public TagAttribute[] getAttrList()
Returns a list of attributes.
Returns:
com.ibm.dse.tools.workbench.base.TagAttribute[]

getName

public java.lang.String getName()
Returns the name of the tag.
Returns:
java.lang.String

getSubTags

public Tag[] getSubTags()
Returns the list of subtags.
Returns:
com.ibm.dse.tools.workbench.base.Tag[]

isAComposedTag

public boolean isAComposedTag()
Indicates whether the Tag is a composed tag or a simple tag.
Returns:
boolean

setAttrList

public void setAttrList(TagAttribute[] aAttrList)
Sets the list of attributes.
Parameters:
aTagAttrList - com.ibm.dse.tools.workbench.base.TagAttribute[]

setName

public void setName(java.lang.String aName)
Sets the name of the tag.
Parameters:
aName - java.lang.String

setSubTagAt

public void setSubTagAt(Tag aSubTag,
                        int index)
                 throws WBInvalidArgumentException
Sets the subTag at the specified index of the list of subTags.

The previous subTag at that position is discarded. The index must be a value greater than or equal to 0 and less than the current size of the vector or a exception will be thrown.

Parameters:
aSubTag - com.ibm.dse.base.Tag
index - int
Throws:
com.ibm.dse.tools.workbench.base.WBInvalidArgumentException. - The index was out of bounds

setSubTags

public void setSubTags(Tag[] someSubTags)
Sets the list of subtags.
Parameters:
someSubTags - com.ibm.dse.tools.workbench.base.Tag[]