Package org.apache.tools.ant.taskdefs
Class Definer
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
- All Implemented Interfaces:
- Cloneable
- Direct Known Subclasses:
- Componentdef,- Typedef
Base class for Taskdef and Typedef - handles all
 the attributes for Typedef. The uri and class
 handling is handled by DefBase
- Since:
- Ant 1.4
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classEnumerated type for format attributestatic classEnumerated type for onError attribute
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidaddDefinition(ClassLoader al, String name, String classname) Add a definition using the attributes of Definervoidexecute()Run the definition.Returns the classname of the object we are defining.getFile()getName()protected voidloadProperties(ClassLoader al, URL url) Load type definitions as properties from a URL.static StringThis is where the logic to map from a URI to an antlib resource is kept.voidsetAdapter(String adapter) Set the class name of the adapter class.protected voidsetAdapterClass(Class<?> adapterClass) Set the adapter class.voidsetAdaptTo(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 voidsetAdaptToClass(Class<?> adaptToClass) Set the class for adaptToClass, to be used by derived classes, used instead of the adaptTo attribute.voidAntlib attribute, sets resource and uri.voidsetClassname(String classname) The full class name of the object being defined.voidName of the property file to load ant name/classname pairs from.voidsetFormat(Definer.Format format) Sets the format of the file or resourcevoidName of the definitionvoidsetOnError(Definer.OnError onError) What to do if there is an error in loading the class.voidsetResource(String res) Name of the property resource to load ant name/classname pairs from.protected voidsetRestrict(boolean restrict) The restrict attribute.Methods inherited from class org.apache.tools.ant.taskdefs.DefBasecreateClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoaderMethods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinitiongetAntlibClassLoader, getURI, setAntlibClassLoader, setURIMethods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
Definerpublic Definer()
 
- 
- 
Method Details- 
setRestrictprotected void setRestrict(boolean restrict) The restrict attribute. If this is true, only use this definition in add(X).- Parameters:
- restrict- the value to set.
 
- 
setOnErrorWhat to do if there is an error in loading the class.- error - throw build exception
- report - output at warning level
- ignore - output at debug level
 - Parameters:
- onError- an- OnErrorvalue
 
- 
setFormatSets the format of the file or resource- Parameters:
- format- the enumerated value - xml or properties
 
- 
getName- Returns:
- the name for this definition
 
- 
getFile- Returns:
- the file containing definitions
 
- 
getResource- Returns:
- the resource containing definitions
 
- 
executeRun the definition.- Overrides:
- executein class- Task
- Throws:
- BuildException- if an error occurs
 
- 
makeResourceFromURIThis is where the logic to map from a URI to an antlib resource is kept.- Parameters:
- uri- the xml namespace uri that to convert.
- Returns:
- the name of a resource. It may not exist
 
- 
loadPropertiesLoad type definitions as properties from a URL.- Parameters:
- al- the classloader to use
- url- the url to get the definitions from
 
- 
setFileName of the property file to load ant name/classname pairs from.- Parameters:
- file- the file
 
- 
setResourceName of the property resource to load ant name/classname pairs from.- Parameters:
- res- the resource to use
 
- 
setAntlibAntlib attribute, sets resource and uri. uri is set the antlib value and, resource is set to the antlib.xml resource in the classpath. For example antlib="antlib:org.acme.bland.cola" corresponds to uri="antlib:org.acme.bland.cola" resource="org/acme/bland/cola/antlib.xml". ASF Bugzilla Bug 31999- Parameters:
- antlib- the value to set.
 
- 
setNameName of the definition- Parameters:
- name- the name of the definition
 
- 
getClassnameReturns the classname of the object we are defining. May benull.- Returns:
- the class name
 
- 
setClassnameThe full class name of the object being defined. Required, unless file or resource have been specified.- Parameters:
- classname- the name of the class
 
- 
setAdapterSet the class name of the adapter class. An adapter class is used to proxy the definition class. It is used if the definition class is not assignable to the adaptto class, or if the adaptto class is not present.- Parameters:
- adapter- the name of the adapter class
 
- 
setAdapterClassSet the adapter class.- Parameters:
- adapterClass- the class to use to adapt the definition class
 
- 
setAdaptToSet the classname of the class that the definition must be compatible with, either directly or by use of the adapter class.- Parameters:
- adaptTo- the name of the adaptto class
 
- 
setAdaptToClassSet the class for adaptToClass, to be used by derived classes, used instead of the adaptTo attribute.- Parameters:
- adaptToClass- the class for adaptor.
 
- 
addDefinitionAdd a definition using the attributes of Definer- Parameters:
- al- the ClassLoader to use
- name- the name of the definition
- classname- the classname of the definition
- Throws:
- BuildException- if an error occurs
 
 
-