RuntimeConfigurable (Apache Ant API)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.RuntimeConfigurable
Wrapper class that holds the attributes of an element, its children, and any text within it. It then takes care of configuring that element at runtime.
Constructor Summary | |
RuntimeConfigurable(java.lang.Object proxy,
java.lang.String elementTag)
Sole constructor creating a wrapper for the specified object. |
Method Summary | |
void |
addChild(RuntimeConfigurable child)
Adds a child element to the wrapped element. |
void |
addText(char[] buf,
int start,
int count)
Adds characters from #PCDATA areas to the wrapped element. |
void |
addText(java.lang.String data)
Adds characters from #PCDATA areas to the wrapped element. |
org.xml.sax.AttributeList |
getAttributes()
Returns the list of attributes for the wrapped element. |
java.lang.String |
getElementTag()
Returns the tag name of the wrapped element. |
void |
maybeConfigure(Project p)
Configures the wrapped element and all its children. |
void |
maybeConfigure(Project p,
boolean configureChildren)
Configures the wrapped element. |
void |
setAttributes(org.xml.sax.AttributeList attributes)
Sets the attributes for the wrapped element. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RuntimeConfigurable(java.lang.Object proxy, java.lang.String elementTag)
proxy
- The element to configure. Must not be null
.elementTag
- The tag name generating this element.
Should not be null
.Method Detail |
public void setAttributes(org.xml.sax.AttributeList attributes)
attributes
- List of attributes defined in the XML for this
element. May be null
.public org.xml.sax.AttributeList getAttributes()
null
.public void addChild(RuntimeConfigurable child)
child
- The child element wrapper to add to this one.
Must not be null
.public void addText(java.lang.String data)
data
- Text to add to the wrapped element.
Should not be null
.public void addText(char[] buf, int start, int count)
buf
- A character array of the text within the element.
Must not be null
.start
- The start element in the array.count
- The number of characters to read from the array.public java.lang.String getElementTag()
null
, but may be.public void maybeConfigure(Project p) throws BuildException
id
attribute, a reference
is added to the project as well.
p
- The project containing the wrapped element.
Must not be null
.
BuildException
- if the configuration fails, for instance due
to invalid attributes or children, or text being added to
an element which doesn't accept it.public void maybeConfigure(Project p, boolean configureChildren) throws BuildException
id
attribute, a reference
is added to the project as well.
p
- The project containing the wrapped element.
Must not be null
.configureChildren
- Whether to configure child elements as
well. if true, child elements will be configured after the
wrapped element.
BuildException
- if the configuration fails, for instance due
to invalid attributes or children, or text being added to
an element which doesn't accept it.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |