com.ibm.pdp.engine
Interface IBuilderTag


public interface IBuilderTag


Field Summary
static java.lang.String copyright
           
 
Method Summary
 IBuilderTag firstSon()
           
 int getBeginIndex()
           
 int getEndIndex()
           
 IGenInfoBuilder getGenInfoBuilder()
           
 java.lang.String getName()
           
 IBuilderTag getParent()
           
 java.lang.String getProperty(java.lang.String name)
           
 int getRelativeBeginIndex()
           
 int getRelativeEndIndex()
           
 java.lang.CharSequence getText()
          see IGenInfoBuilder.getText() for more information
 java.lang.CharSequence getTextAfter()
          see IGenInfoBuilder.getText() for more information
 java.lang.CharSequence getTextBefore()
          see IGenInfoBuilder.getText() for more information
 boolean hasSon()
           
 IBuilderTag lastSon()
           
 IBuilderTag nextTag()
           
 IBuilderTag previousTag()
           
 java.util.Iterator<java.lang.String> propertyNames()
           
 void setProperty(java.lang.String name, java.lang.String value)
           
 void setText(java.lang.CharSequence newText)
          This method replaces the old text between the getBeginIndex() and the getEndIndex() and put the newText.
 void setTextAfter(java.lang.CharSequence newText)
          This method replaces the text between the current tag and its next tag.
 void setTextBefore(java.lang.CharSequence newText)
          This method replaces the text between the current tag and its previous tag.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

firstSon

IBuilderTag firstSon()
Returns:
The first son of the current tag or null if the current tag has no son.

getBeginIndex

int getBeginIndex()
Returns:
The begin index for the current tag

getEndIndex

int getEndIndex()
Returns:
The end index of the current tag

getGenInfoBuilder

IGenInfoBuilder getGenInfoBuilder()
Returns:
The IGenInfoBuilder in which the tag is defined.

getName

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

getParent

IBuilderTag getParent()
Returns:
The parent tag for the current tag or null if the current has no parent (it is the root tag).

getProperty

java.lang.String getProperty(java.lang.String name)
Parameters:
name - : The property name to search for
Returns:
The value of the property name

getRelativeBeginIndex

int getRelativeBeginIndex()
Returns:
the begin index, relative to it parent

getRelativeEndIndex

int getRelativeEndIndex()
Returns:
The end index, relative to it parent

getText

java.lang.CharSequence getText()
see IGenInfoBuilder.getText() for more information

Returns:
The text in the current tag

getTextAfter

java.lang.CharSequence getTextAfter()
see IGenInfoBuilder.getText() for more information

Returns:
The text before the current tag.

getTextBefore

java.lang.CharSequence getTextBefore()
see IGenInfoBuilder.getText() for more information

Returns:
The text after the current tag.

hasSon

boolean hasSon()
Returns:
A boolean indicating if this tag has son or not.

lastSon

IBuilderTag lastSon()
Returns:
the last son of the current tag or null if the current tag has no son.

nextTag

IBuilderTag nextTag()
Returns:
The next tag. The next tag is the next brother for the current tag. The next tag has the same parent as the current tag and it is after the current tag in the list of the parent's sons. This method returns null if the current tag is the last son of its parent.

previousTag

IBuilderTag previousTag()
Returns:
The previous tag. The previous tag is the previous brother for the current tag. The previous tag has the same parent as the current tag and it is before the current tag in the list of the parent's sons. This method returns null if the current tag is the first son of its parent.

propertyNames

java.util.Iterator<java.lang.String> propertyNames()
Returns:
An iterator which contains all the names of the properties

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)
Parameters:
name - : The property name to set
value - : The value of the property name

setText

void setText(java.lang.CharSequence newText)
This method replaces the old text between the getBeginIndex() and the getEndIndex() and put the newText.

Parameters:
newText - : The new text to replace the current text.

setTextAfter

void setTextAfter(java.lang.CharSequence newText)
This method replaces the text between the current tag and its next tag. If the current tag has no next tag, it replaces the text between the end of the tag and the end of its parent

Parameters:
newText - : The new text

setTextBefore

void setTextBefore(java.lang.CharSequence newText)
This method replaces the text between the current tag and its previous tag. If the current tag has no next tag, it replaces the text between the beginning of its parent and the beginning of the tag.

Parameters:
newText -