TaskAdapter (Apache Ant API)

org.apache.tools.ant
Class TaskAdapter


java.lang.Object

  |

  +--org.apache.tools.ant.ProjectComponent

        |

        +--org.apache.tools.ant.Task

              |

              +--org.apache.tools.ant.TaskAdapter


public class TaskAdapter
extends Task

Uses introspection to "adapt" an arbitrary Bean which doesn't itself extend Task, but still contains an execute method and optionally a setProject method.

Author:
costin@dnt.ro

Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
description, location, target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
TaskAdapter()
           
 
Method Summary
static void checkTaskClass(java.lang.Class taskClass, Project project)
          Checks whether or not a class is suitable to be adapted by TaskAdapter.
 void execute()
          Executes the proxied task.
 java.lang.Object getProxy()
          Returns the target object being proxied.
 void setProxy(java.lang.Object o)
          Sets the target object to proxy for.
 
Methods inherited from class org.apache.tools.ant.Task
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TaskAdapter


public TaskAdapter()
Method Detail

checkTaskClass


public static void checkTaskClass(java.lang.Class taskClass,
                                  Project project)
Checks whether or not a class is suitable to be adapted by TaskAdapter. This only checks conditions which are additionally required for tasks adapted by TaskAdapter. Thus, this method should be called by Project.checkTaskClass. Throws a BuildException and logs as Project.MSG_ERR for conditions that will cause the task execution to fail. Logs other suspicious conditions with Project.MSG_WARN.

Parameters:
taskClass - Class to test for suitability. Must not be null.
project - Project to log warnings/errors to. Must not be null.
See Also:
Project.checkTaskClass(Class)

execute


public void execute()
             throws BuildException
Executes the proxied task.

Overrides:
execute in class Task
Throws:
BuildException - if the project could not be set or the method could not be executed.

setProxy


public void setProxy(java.lang.Object o)
Sets the target object to proxy for.

Parameters:
o - The target object. Must not be null.

getProxy


public java.lang.Object getProxy()
Returns the target object being proxied.

Returns:
the target proxy object


Copyright 2000-2002 Apache Software Foundation. All Rights Reserved.