Package org.apache.tools.ant
Class UnknownElement
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.UnknownElement
-
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
ConstructorDescriptionUnknownElement
(String elementName) Creates an UnknownElement for the given element name. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addChild
(UnknownElement child) Adds a child element to this element.void
This is used then the realobject of the UE is a PreSetDefinition.void
Configure the given object from this UnknownElementMake a copy of the unknown element and set it in the new project.void
execute()
Executes the real object if it's a task.protected String
Return the namespace of the XML element associated with this component.protected BuildException
getNotFoundException
(String what, String name) Returns a very verbose exception for when a task/data type cannot be found.getQName()
Return the qname of the XML element associated with this component.Return the configured objectgetTag()
Returns the name of the XML element which generated this unknown element.getTask()
Returns the task instance after it has been created and if it is a task.Returns the name to use in logging messages.Get the RuntimeConfigurable instance for this UnknownElement, containing the configuration information.protected void
handleChildren
(Object parent, RuntimeConfigurable parentWrapper) Creates child elements, creates children of the children (recursively), and sets attributes of the child elements.protected void
handleErrorFlush
(String output) Handles error output sent to System.err by this task or its real task.protected void
handleErrorOutput
(String output) Handles error output sent to System.err by this task or its real task.protected void
handleFlush
(String output) Handles output sent to System.out by this task or its real task.protected int
handleInput
(byte[] buffer, int offset, int length) Delegate to realThing if present and if it as task.protected void
handleOutput
(String output) Handles output sent to System.out by this task or its real task.protected Object
Creates a named task or data type.protected Task
Creates a named task and configures it up to the init() stage.void
Creates the real object instance and child elements, then configures the attributes and text of the real object.void
setNamespace
(String namespace) Set the namespace of the XML element associated with this component.void
Set the namespace qname of the XML element.void
setRealThing
(Object realThing) Set the configured objectboolean
like contents equals, but ignores projectMethods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskType, init, isInvalid, log, log, log, log, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
UnknownElement
Creates an UnknownElement for the given element name.- Parameters:
elementName
- The name of the unknown element. Must not benull
.
-
-
Method Details
-
getChildren
- Returns:
- the list of nested UnknownElements for this UnknownElement.
-
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.
-
getNamespace
Return the namespace of the XML element associated with this component.- Returns:
- Namespace URI used in the xmlns declaration.
-
setNamespace
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.
-
getQName
Return the qname of the XML element associated with this component.- Returns:
- namespace Qname used in the element declaration.
-
setQName
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
-
getWrapper
Get the RuntimeConfigurable instance for this UnknownElement, containing the configuration information.- Overrides:
getWrapper
in classTask
- Returns:
- the configuration info.
-
maybeConfigure
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 classTask
- Throws:
BuildException
- if the configuration fails
-
configure
Configure the given object from this UnknownElement- Parameters:
realObject
- the real object this UnknownElement is representing.
-
handleOutput
Handles output sent to System.out by this task or its real task.- Overrides:
handleOutput
in classTask
- Parameters:
output
- The output to log. Should not benull
.
-
handleInput
Delegate to realThing if present and if it as task.- Overrides:
handleInput
in classTask
- 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.
- Throws:
IOException
- if the data cannot be read.- Since:
- Ant 1.6
- See Also:
-
handleFlush
Handles output sent to System.out by this task or its real task.- Overrides:
handleFlush
in classTask
- Parameters:
output
- The output to log. Should not benull
.
-
handleErrorOutput
Handles error output sent to System.err by this task or its real task.- Overrides:
handleErrorOutput
in classTask
- Parameters:
output
- The error output to log. Should not benull
.
-
handleErrorFlush
Handles error output sent to System.err by this task or its real task.- Overrides:
handleErrorFlush
in classTask
- Parameters:
output
- The error output to log. Should not benull
.
-
execute
-
addChild
Adds a child element to this element.- Parameters:
child
- The child element to add. Must not benull
.
-
handleChildren
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.
-
getComponentName
- Returns:
- the component name - uses ProjectHelper#genComponentName()
-
applyPreSet
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
-
makeObject
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.
-
makeTask
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.
-
getNotFoundException
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.
-
getTaskName
Returns the name to use in logging messages.- Overrides:
getTaskName
in classTask
- Returns:
- the name to use in logging messages.
-
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.
-
getRealThing
Return the configured object- Returns:
- the real thing whatever it is
- Since:
- ant 1.6
-
setRealThing
Set the configured object- Parameters:
realThing
- the configured object- Since:
- ant 1.7
-
similar
like contents equals, but ignores project- Parameters:
obj
- the object to check against- Returns:
- true if this UnknownElement has the same contents the other
-
copy
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.
-