Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.UnknownElement
public class UnknownElement
extends Task
Field Summary |
Fields inherited from class org.apache.tools.ant.ProjectComponent | |
description , location , project |
Constructor Summary | |
|
Method Summary | |
void |
|
void |
|
void |
|
UnknownElement | |
void |
|
List | |
protected String | |
String |
|
protected BuildException |
|
String |
|
Object |
|
String |
|
Task |
|
String |
|
RuntimeConfigurable |
|
protected void |
|
protected void |
|
protected void |
|
protected void |
|
protected int |
|
protected void |
|
protected Object |
|
protected Task |
|
void |
|
void |
|
void |
|
void |
|
boolean |
|
Methods inherited from class org.apache.tools.ant.Task | |
bindToOwner , execute , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , log , log , maybeConfigure , perform , reconfigure , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent | |
clone , getDescription , getLocation , getProject , log , log , setDescription , setLocation , setProject |
public UnknownElement(String elementName)
Creates an UnknownElement for the given element name.
- Parameters:
elementName
- The name of the unknown element. Must not benull
.
public void addChild(UnknownElement child)
Adds a child element to this element.
- Parameters:
child
- The child element to add. Must not benull
.
public void applyPreSet(UnknownElement u)
This is used then the realobject of the UE is a PreSetDefinition. This is also used when a presetdef is used on a presetdef The attributes, elements and text are applied to this UE.
- Parameters:
u
- an UnknownElement containing the attributes, elements and text
public void configure(Object realObject)
Configure the given object from this UnknownElement
- Parameters:
realObject
- the real object this UnknownElement is representing.
public UnknownElement copy(Project newProject)
Make a copy of the unknown element and set it in the new project.
- Parameters:
newProject
- the project to create the UE in.
- Returns:
- the copied UE.
public void execute()
Executes the real object if it's a task. If it's not a task (e.g. a data type) then this method does nothing.
public List getChildren()
- Returns:
- the list of nested UnknownElements for this UnknownElement.
protected String getComponentName()
- Returns:
- the component name - uses ProjectHelper#genComponentName()
public String getNamespace()
Return the namespace of the XML element associated with this component.
- Returns:
- Namespace URI used in the xmlns declaration.
protected BuildException getNotFoundException(String what, String name)
Returns a very verbose exception for when a task/data type cannot be found.
- Parameters:
what
- The kind of thing being created. For example, when a task name could not be found, this would be"task"
. Should not benull
.name
- The name of the element which could not be found. Should not benull
.
- Returns:
- a detailed description of what might have caused the problem.
public String getQName()
Return the qname of the XML element associated with this component.
- Returns:
- namespace Qname used in the element declaration.
public Object getRealThing()
Return the configured object
- Returns:
- the real thing whatever it is
- Since:
- ant 1.6
public String getTag()
Returns the name of the XML element which generated this unknown element.
- Returns:
- the name of the XML element which generated this unknown element.
public Task getTask()
Returns the task instance after it has been created and if it is a task.
- Returns:
- a task instance or
null
if the real object is not a task.
public String getTaskName()
Returns the name to use in logging messages.
- Overrides:
- getTaskName in interface Task
- Returns:
- the name to use in logging messages.
public RuntimeConfigurable getWrapper()
Get the RuntimeConfigurable instance for this UnknownElement, containing the configuration information.
- Overrides:
- getWrapper in interface Task
- Returns:
- the configuration info.
protected void handleChildren(Object parent, RuntimeConfigurable parentWrapper) throws BuildException
Creates child elements, creates children of the children (recursively), and sets attributes of the child elements.
- Parameters:
parent
- The configured object for the parent. Must not benull
.parentWrapper
- The wrapper containing child wrappers to be configured. Must not benull
if there are any children.
- Throws:
BuildException
- if the children cannot be configured.
protected void handleErrorFlush(String output)
Handles error output sent to System.err by this task or its real task.
- Overrides:
- handleErrorFlush in interface Task
- Parameters:
output
- The error output to log. Should not benull
.
protected void handleErrorOutput(String output)
Handles error output sent to System.err by this task or its real task.
- Overrides:
- handleErrorOutput in interface Task
- Parameters:
output
- The error output to log. Should not benull
.
protected void handleFlush(String output)
Handles output sent to System.out by this task or its real task.
- Overrides:
- handleFlush in interface Task
- Parameters:
output
- The output to log. Should not benull
.
protected int handleInput(byte[] buffer, int offset, int length) throws IOException
Delegate to realThing if present and if it as task.
- Overrides:
- handleInput in interface Task
- Parameters:
buffer
- the buffer into which data is to be read.offset
- the offset into the buffer at which data is stored.length
- the amount of data to read.
- Returns:
- the number of bytes read.
- Since:
- Ant 1.6
- See Also:
Task.handleInput(byte[],int,int)
protected void handleOutput(String output)
Handles output sent to System.out by this task or its real task.
- Overrides:
- handleOutput in interface Task
- Parameters:
output
- The output to log. Should not benull
.
protected Object makeObject(UnknownElement ue, RuntimeConfigurable w)
Creates a named task or data type. If the real object is a task, it is configured up to the init() stage.
- Parameters:
ue
- The unknown element to create the real object for. Must not benull
.w
- Ignored in this implementation.
- Returns:
- the task or data type represented by the given unknown element.
protected Task makeTask(UnknownElement ue, RuntimeConfigurable w)
Creates a named task and configures it up to the init() stage.
- Parameters:
ue
- The UnknownElement to create the real task for. Must not benull
.w
- Ignored.
- Returns:
- the task specified by the given unknown element, or
null
if the task name is not recognised.
public void maybeConfigure() throws BuildException
Creates the real object instance and child elements, then configures the attributes and text of the real object. This unknown element is then replaced with the real object in the containing target's list of children.
- Overrides:
- maybeConfigure in interface Task
- Throws:
BuildException
- if the configuration fails
public void setNamespace(String namespace)
Set the namespace of the XML element associated with this component. This method is typically called by the XML processor. If the namespace is "ant:current", the component helper is used to get the current antlib uri.
- Parameters:
namespace
- URI used in the xmlns declaration.
public void setQName(String qname)
Set the namespace qname of the XML element. This method is typically called by the XML processor.
- Parameters:
qname
- the qualified name of the element
public void setRealThing(Object realThing)
Set the configured object
- Parameters:
realThing
- the configured object
- Since:
- ant 1.7
public boolean similar(Object obj)
like contents equals, but ignores project
- Parameters:
obj
- the object to check against
- Returns:
- true if this unknownelement has the same contents the other