Componentdef (Apache Ant API)
Description: declaration: package: org.apache.tools.ant.taskdefs, class: Componentdef

# Class Componentdef

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.AntlibDefinition
org.apache.tools.ant.taskdefs.DefBase
org.apache.tools.ant.taskdefs.Definer
org.apache.tools.ant.taskdefs.Componentdef

All Implemented Interfaces:
  `Cloneable`

public class Componentdef extends Definer
Adds a component definition to the current project.

Used in the current project two attributes are needed, the name that identifies this component uniquely, and the full name of the class (including the packages) that implements this component.

Since:
  Ant 1.8

- ## Nested Class Summary

  ### Nested classes/interfaces inherited from class Definer

  `Definer.Format, Definer.OnError`
  Modifier and Type
  Class
  Description
  `static class`
  `Definer.Format`
  Enumerated type for format attribute
  `static class`
  `Definer.OnError`
  Enumerated type for onError attribute

- ## Field Summary

  ### Fields inherited from class Task

  `target, taskName, taskType, wrapper`
  Modifier and Type
  Field
  Description
  `protected Target`
  `target`
  Deprecated.
  since 1.6.x.
  `protected String`
  `taskName`
  Deprecated.
  since 1.6.x.
  `protected String`
  `taskType`
  Deprecated.
  since 1.6.x.
  `protected RuntimeConfigurable`
  `wrapper`
  Deprecated.
  since 1.6.x.

  ### Fields inherited from class ProjectComponent

  `description, location, project`
  Modifier and Type
  Field
  Description
  `protected String`
  `description`
  Deprecated.
  since 1.6.x.
  `protected Location`
  `location`
  Deprecated.
  since 1.6.x.
  `protected Project`
  `project`
  Deprecated.
  since 1.6.x.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `Componentdef()`
  Default constructor.

- ## Method Summary

  ### Methods inherited from class Definer

  `addDefinition, execute, getClassname, getFile, getName, getResource, loadProperties, makeResourceFromURI, setAdapter, setAdapterClass, setAdaptTo, setAdaptToClass, setAntlib, setClassname, setFile, setFormat, setName, setOnError, setResource, setRestrict`
  Modifier and Type
  Method
  Description
  `protected void`
  `addDefinition(ClassLoader al, String name, String classname)`
  Add a definition using the attributes of Definer
  `void`
  `execute()`
  Run the definition.
  `String`
  `getClassname()`
  Returns the classname of the object we are defining.
  `File`
  `getFile()`
  `String`
  `getName()`
  `String`
  `getResource()`
  `protected void`
  `loadProperties(ClassLoader al, URL url)`
  Load type definitions as properties from a URL.
  `static String`
  `makeResourceFromURI(String uri)`
  This is where the logic to map from a URI to an antlib resource is kept.
  `void`
  `setAdapter(String adapter)`
  Set the class name of the adapter class.
  `protected void`
  `setAdapterClass(Class<?> adapterClass)`
  Set the adapter class.
  `void`
  `setAdaptTo(String adaptTo)`
  Set the classname of the class that the definition must be compatible with, either directly or by use of the adapter class.
  `protected void`
  `setAdaptToClass(Class<?> adaptToClass)`
  Set the class for adaptToClass, to be used by derived classes, used instead of the adaptTo attribute.
  `void`
  `setAntlib(String antlib)`
  Antlib attribute, sets resource and uri.
  `void`
  `setClassname(String classname)`
  The full class name of the object being defined.
  `void`
  `setFile(File file)`
  Name of the property file to load ant name/classname pairs from.
  `void`
  `setFormat(Definer.Format format)`
  Sets the format of the file or resource
  `void`
  `setName(String name)`
  Name of the definition
  `void`
  `setOnError(Definer.OnError onError)`
  What to do if there is an error in loading the class.
  `void`
  `setResource(String res)`
  Name of the property resource to load ant name/classname pairs from.
  `protected void`
  `setRestrict(boolean restrict)`
  The restrict attribute.

  ### Methods inherited from class DefBase

  `createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader`
  Modifier and Type
  Method
  Description
  `Path`
  `createClasspath()`
  Create the classpath to be used when searching for component being defined.
  `protected ClassLoader`
  `createLoader()`
  create a classloader for this definition
  `Path`
  `getClasspath()`
  `String`
  `getClasspathId()`
  Returns the class path id of the class path delegate.
  `String`
  `getLoaderId()`
  Returns the loader id of the class path Delegate.
  `protected boolean`
  `hasCpDelegate()`
  Check if classpath attributes have been set.
  `void`
  `init()`
  Called by the project to let the task initialize properly.
  `boolean`
  `isReverseLoader()`
  `void`
  `setClasspath(Path classpath)`
  Set the classpath to be used when searching for component being defined.
  `void`
  `setClasspathRef(Reference r)`
  Set a reference to a classpath to use when loading the files.
  `void`
  `setLoaderRef(Reference r)`
  Use the reference to locate the loader.
  `void`
  `setReverseLoader(boolean reverseLoader)`
  Deprecated.
  since 1.6.x.

  ### Methods inherited from class AntlibDefinition

  `getAntlibClassLoader, getURI, setAntlibClassLoader, setURI`
  Modifier and Type
  Method
  Description
  `ClassLoader`
  `getAntlibClassLoader()`
  The current antlib classloader
  `String`
  `getURI()`
  The URI for this definition.
  `void`
  `setAntlibClassLoader(ClassLoader classLoader)`
  Set the class loader of the loading object
  `void`
  `setURI(String uri)`
  The URI for this definition.

  ### Methods inherited from class Task

  `bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType`
  Modifier and Type
  Method
  Description
  `final void`
  `bindToOwner(Task owner)`
  Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
  `Target`
  `getOwningTarget()`
  Returns the container target of this task.
  `RuntimeConfigurable`
  `getRuntimeConfigurableWrapper()`
  Returns the wrapper used for runtime configuration.
  `String`
  `getTaskName()`
  Returns the name to use in logging messages.
  `String`
  `getTaskType()`
  Return the type of task.
  `protected RuntimeConfigurable`
  `getWrapper()`
  Return the runtime configurable structure for this task.
  `protected void`
  `handleErrorFlush(String output)`
  Handles an error line by logging it with the WARN priority.
  `protected void`
  `handleErrorOutput(String output)`
  Handles an error output by logging it with the WARN priority.
  `protected void`
  `handleFlush(String output)`
  Handles output by logging it with the INFO priority.
  `protected int`
  `handleInput(byte[] buffer, int offset, int length)`
  Handle an input request by this task.
  `protected void`
  `handleOutput(String output)`
  Handles output by logging it with the INFO priority.
  `protected final boolean`
  `isInvalid()`
  Has this task been marked invalid?
  `void`
  `log(String msg)`
  Logs a message with the default (INFO) priority.
  `void`
  `log(String msg, int msgLevel)`
  Logs a message with the given priority.
  `void`
  `log(String msg, Throwable t, int msgLevel)`
  Logs a message with the given priority.
  `void`
  `log(Throwable t, int msgLevel)`
  Logs a message with the given priority.
  `void`
  `maybeConfigure()`
  Configures this task - if it hasn't been done already.
  `final void`
  `perform()`
  Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
  `void`
  `reconfigure()`
  Force the task to be reconfigured from its RuntimeConfigurable.
  `void`
  `setOwningTarget(Target target)`
  Sets the target container of this task.
  `void`
  `setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)`
  Sets the wrapper to be used for runtime configuration.
  `void`
  `setTaskName(String name)`
  Sets the name to use in logging messages.
  `void`
  `setTaskType(String type)`
  Sets the name with which the task has been invoked.

  ### Methods inherited from class ProjectComponent

  `clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject`
  Modifier and Type
  Method
  Description
  `Object`
  `clone()`
  `String`
  `getDescription()`
  Returns the description of the current action.
  `Location`
  `getLocation()`
  Returns the file/location where this task was defined.
  `Project`
  `getProject()`
  Returns the project to which this component belongs.
  `void`
  `setDescription(String desc)`
  Sets a description of the current action.
  `void`
  `setLocation(Location location)`
  Sets the file/location where this task was defined.
  `void`
  `setProject(Project project)`
  Sets the project object of this component.

  ### Methods inherited from class Object

  `equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Constructor Details

  - ### Componentdef

    public Componentdef()
    Default constructor. Creates a new Componentdef instance. Sets the restrict attribute to true.