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

Modifier and Type	Field and Description
private String	adapter
private Class<?>	adapterClass
private String	adaptTo
private Class<?>	adaptToClass
private static final String	ANTLIB_XML the extension of an antlib file for autoloading.
private String	classname
private boolean	definerSet
private File	file
private int	format
private String	name
private int	onError
private String	resource
private static final ThreadLocal<Map<URL, Location>>	RESOURCE_STACK
private boolean	restrict

Access	Constructor and Description
public	Definer()

Method Summary

Modifier and Type	Method and Description
protected void	addDefinition(ClassLoader the ClassLoader to use al, String the name of the definition name, String the classname of the definition classname) Add a definition using the attributes of Definer
public void	execute() Overrides org.apache.tools.ant.Task.execute. Run the definition.
private URL	Returns: the URL, or null if it isn't valid and the active error policy is not to raise a fault fileToURL() Convert a file to a file: URL.
public String	Returns: the class name getClassname() Returns the classname of the object we are defining.
public File	Returns: the file containing definitions getFile()
public String	Returns: the name for this definition getName()
public String	Returns: the resource containing definitions getResource()
private void	loadAntlib(ClassLoader the classloader to use. classLoader, URL the url to load the definitions from. url) Load an antlib from a URL.
protected void	loadProperties(ClassLoader the classloader to use al, URL the url to get the definitions from url) Load type definitions as properties from a URL.
public static String	Returns: the name of a resource. It may not exist makeResourceFromURI(String the xml namespace uri that to convert. uri) This is where the logic to map from a URI to an antlib resource is kept.
private Enumeration<URL>	resourceToURLs(ClassLoader classLoader)
public void	setAdapter(String the name of the adapter class adapter) Set the class name of the adapter class.
protected void	setAdapterClass(Class<?> the class to use to adapt the definition class adapterClass) Set the adapter class.
public void	setAdaptTo(String the name of the adaptto class 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<?> the class for adaptor. adaptToClass) Set the class for adaptToClass, to be used by derived classes, used instead of the adaptTo attribute.
public void	setAntlib(String the value to set. antlib) Antlib attribute, sets resource and uri.
public void	setClassname(String the name of the class classname) The full class name of the object being defined.
public void	setFile(File the file file) Name of the property file to load ant name/classname pairs from.
public void	setFormat(Definer.Format the enumerated value - xml or properties format) Sets the format of the file or resource
public void	setName(String the name of the definition name) Name of the definition
public void	setOnError(Definer.OnError an `OnError` value onError) What to do if there is an error in loading the class.
public void	setResource(String the resource to use res) Name of the property resource to load ant name/classname pairs from.
protected void	setRestrict(boolean the value to set. restrict) The restrict attribute.
private void	tooManyDefinitions() handle too many definitions by raising an exception.

Inherited from org.apache.tools.ant.taskdefs.DefBase:: createClasspath createLoader getClasspath getClasspathId getLoaderId hasCpDelegate init isReverseLoader setClasspath setClasspathRef setLoaderRef setReverseLoader

Field Detail

adapter	back to summary
private String adapter

adapterClass	back to summary
private Class<?> adapterClass

adaptTo	back to summary
private String adaptTo

adaptToClass	back to summary
private Class<?> adaptToClass

ANTLIB_XML	back to summary
private static final String ANTLIB_XML the extension of an antlib file for autoloading. /antlib.xml

classname	back to summary
private String classname

definerSet	back to summary
private boolean definerSet

file	back to summary
private File file

format	back to summary
private int format

name	back to summary
private String name

onError	back to summary
private int onError

resource	back to summary
private String resource

RESOURCE_STACK	back to summary
private static final ThreadLocal<Map<URL, Location>> RESOURCE_STACK

restrict	back to summary
private boolean restrict

Constructor Detail

Definer	back to summary
public Definer()

Method Detail

addDefinition	back to summary
protected void addDefinition(ClassLoader al, String name, String classname) throws BuildException Add a definition using the attributes of Definer Parameters al:ClassLoader the ClassLoader to use name:String the name of the definition classname:String the classname of the definition Exceptions BuildException: if an error occurs

addDefinition

back to summary

protected void addDefinition(ClassLoader al, String name, String classname) throws BuildException

Add a definition using the attributes of Definer

Parameters

al:ClassLoader: the ClassLoader to use
name:String: the name of the definition
classname:String: the classname of the definition

Exceptions

BuildException:: if an error occurs

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Run the definition. Annotations @Override Exceptions BuildException: if an error occurs

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Run the definition.

Annotations

@Override

Exceptions

BuildException:: if an error occurs

fileToURL	back to summary
private URL fileToURL() Convert a file to a file: URL. Returns:URL the URL, or null if it isn't valid and the active error policy is not to raise a fault Exceptions BuildException: if the file is missing/not a file and the policy requires failure at this point.

fileToURL

back to summary

private URL fileToURL()

Convert a file to a file: URL.

Returns:URL

the URL, or null if it isn't valid and the active error policy is not to raise a fault

Exceptions

BuildException:: if the file is missing/not a file and the policy requires failure at this point.

getClassname back to summary

getClassname	back to summary
public String getClassname() Returns the classname of the object we are defining. May be `null`. Returns:String the class name

public String getClassname()

Returns the classname of the object we are defining. May be null.

Returns:String: the class name

getFile	back to summary
public File getFile() Returns:File the file containing definitions

getName	back to summary
public String getName() Returns:String the name for this definition

getResource	back to summary
public String getResource() Returns:String the resource containing definitions

loadAntlib	back to summary
private void loadAntlib(ClassLoader classLoader, URL url) Load an antlib from a URL. Parameters classLoader:ClassLoader the classloader to use. url:URL the url to load the definitions from.

loadAntlib

back to summary

private void loadAntlib(ClassLoader classLoader, URL url)

Load an antlib from a URL.

Parameters

classLoader:ClassLoader: the classloader to use.
url:URL: the url to load the definitions from.

loadProperties	back to summary
protected void loadProperties(ClassLoader al, URL url) Load type definitions as properties from a URL. Parameters al:ClassLoader the classloader to use url:URL the url to get the definitions from

loadProperties

back to summary

protected void loadProperties(ClassLoader al, URL url)

Load type definitions as properties from a URL.

Parameters

al:ClassLoader: the classloader to use
url:URL: the url to get the definitions from

makeResourceFromURI	back to summary
public static String makeResourceFromURI(String uri) This is where the logic to map from a URI to an antlib resource is kept. Parameters uri:String the xml namespace uri that to convert. Returns:String the name of a resource. It may not exist

makeResourceFromURI

back to summary

public static String makeResourceFromURI(String uri)

This is where the logic to map from a URI to an antlib resource is kept.

Parameters

uri:String: the xml namespace uri that to convert.

Returns:String

the name of a resource. It may not exist

resourceToURLs	back to summary
private Enumeration<URL> resourceToURLs(ClassLoader classLoader)

setAdapter	back to summary
public void setAdapter(String adapter) Set 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:String the name of the adapter class

setAdapter

back to summary

public void setAdapter(String adapter)

Set 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:String: the name of the adapter class

setAdapterClass	back to summary
protected void setAdapterClass(Class<?> adapterClass) Set the adapter class. Parameters adapterClass:Class<?> the class to use to adapt the definition class

setAdapterClass

back to summary

protected void setAdapterClass(Class<?> adapterClass)

Set the adapter class.

Parameters

adapterClass:Class<?>: the class to use to adapt the definition class

setAdaptTo	back to summary
public 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. Parameters adaptTo:String the name of the adaptto class

setAdaptTo

back to summary

public 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.

Parameters

adaptTo:String: the name of the adaptto class

setAdaptToClass	back to summary
protected void setAdaptToClass(Class<?> adaptToClass) Set the class for adaptToClass, to be used by derived classes, used instead of the adaptTo attribute. Parameters adaptToClass:Class<?> the class for adaptor.

setAdaptToClass

back to summary

protected void setAdaptToClass(Class<?> adaptToClass)

Set the class for adaptToClass, to be used by derived classes, used instead of the adaptTo attribute.

Parameters

adaptToClass:Class<?>: the class for adaptor.

setAntlib	back to summary
public void setAntlib(String antlib) Antlib 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:String the value to set.

setAntlib

back to summary

public void setAntlib(String antlib)

Antlib 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:String: the value to set.

setClassname	back to summary
public void setClassname(String classname) The full class name of the object being defined. Required, unless file or resource have been specified. Parameters classname:String the name of the class

setClassname

back to summary

public void setClassname(String classname)

The full class name of the object being defined. Required, unless file or resource have been specified.

Parameters

classname:String: the name of the class

setFile	back to summary
public void setFile(File file) Name of the property file to load ant name/classname pairs from. Parameters file:File the file

setFile

back to summary

public void setFile(File file)

Name of the property file to load ant name/classname pairs from.

Parameters

file:File: the file

setFormat	back to summary
public void setFormat(Definer.Format format) Sets the format of the file or resource Parameters format:Definer.Format the enumerated value - xml or properties

setFormat

back to summary

public void setFormat(Definer.Format format)

Sets the format of the file or resource

Parameters

format:Definer.Format: the enumerated value - xml or properties

setName	back to summary
public void setName(String name) Name of the definition Parameters name:String the name of the definition

setName

back to summary

public void setName(String name)

Name of the definition

Parameters

name:String: the name of the definition

setOnError back to summary

setOnError	back to summary
public void setOnError(Definer.OnError onError) What 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:Definer.OnError an `OnError` value

public void setOnError(Definer.OnError onError)

What 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:Definer.OnError: an OnError value

setResource	back to summary
public void setResource(String res) Name of the property resource to load ant name/classname pairs from. Parameters res:String the resource to use

setResource

back to summary

public void setResource(String res)

Name of the property resource to load ant name/classname pairs from.

Parameters

res:String: the resource to use

setRestrict	back to summary
protected void setRestrict(boolean restrict) The restrict attribute. If this is true, only use this definition in add(X). Parameters restrict:boolean the value to set.

setRestrict

back to summary

protected void setRestrict(boolean restrict)

The restrict attribute. If this is true, only use this definition in add(X).

Parameters

restrict:boolean: the value to set.

tooManyDefinitions	back to summary
private void tooManyDefinitions() handle too many definitions by raising an exception. Exceptions BuildException: always.

tooManyDefinitions

back to summary

private void tooManyDefinitions()

handle too many definitions by raising an exception.

Exceptions

BuildException:: always.

org.apache.tools.ant.taskdefs back to summary

public Class Definer.Format

Class Inheritance

extends EnumeratedAttribute

java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
org.apache.tools.ant.taskdefs.Definer.Format

Enumerated type for format attribute

See Also: EnumeratedAttribute

Field Summary

Modifier and Type	Field and Description
public static final int	PROPERTIES Enumerated values
public static final int	XML Enumerated values

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: value

Constructor Summary

Access	Constructor and Description
public	Format()

Method Summary

Modifier and Type	Method and Description
public String[]	Returns: an array of the allowed values for this attribute. getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. get the values

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: containsValue getIndex getInstance getValue indexOfValue setValue toString

Field Detail

PROPERTIES	back to summary
public static final int PROPERTIES Enumerated values

XML	back to summary
public static final int XML Enumerated values

Constructor Detail

Format	back to summary
public Format()

Method Detail

getValues	back to summary
public String[] getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. get the values Returns:String[] an array of the allowed values for this attribute. Annotations @Override

getValues

back to summary

public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

get the values

Returns:String[]

an array of the allowed values for this attribute.

Annotations

@Override

org.apache.tools.ant.taskdefs back to summary

public Class Definer.OnError

Class Inheritance

extends EnumeratedAttribute

java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
org.apache.tools.ant.taskdefs.Definer.OnError

Enumerated type for onError attribute

See Also: EnumeratedAttribute

Field Summary

Modifier and Type	Field and Description
public static final int	FAIL Enumerated values
public static final int	FAIL_ALL Enumerated values
public static final int	IGNORE Enumerated values
public static final String	POLICY_FAIL text value of onerror option fail
public static final String	POLICY_FAILALL text value of onerror option failall
public static final String	POLICY_IGNORE text value of onerror option ignore
public static final String	POLICY_REPORT text value of onerror option report
public static final int	REPORT Enumerated values

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: value

Constructor Summary

Access	Constructor and Description
public	OnError() Constructor
public	OnError(String the value of the attribute value) Constructor using a string.

Method Summary

Modifier and Type	Method and Description
public String[]	Returns: an array of the allowed values for this attribute. getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. get the values

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: containsValue getIndex getInstance getValue indexOfValue setValue toString

Field Detail

FAIL	back to summary
public static final int FAIL Enumerated values

FAIL_ALL	back to summary
public static final int FAIL_ALL Enumerated values

IGNORE	back to summary
public static final int IGNORE Enumerated values

POLICY_FAIL	back to summary
public static final String POLICY_FAIL text value of onerror option fail

POLICY_FAILALL	back to summary
public static final String POLICY_FAILALL text value of onerror option failall

POLICY_IGNORE	back to summary
public static final String POLICY_IGNORE text value of onerror option ignore

POLICY_REPORT	back to summary
public static final String POLICY_REPORT text value of onerror option report

REPORT	back to summary
public static final int REPORT Enumerated values

Constructor Detail

OnError	back to summary
public OnError() Constructor

OnError

back to summary

public OnError(String value)

Constructor using a string.

Parameters

value:String: the value of the attribute

Method Detail

getValues

back to summary

public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

get the values

Returns:String[]

an array of the allowed values for this attribute.

Annotations

@Override

public abstract Class Definer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Definer.Format

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Definer.OnError

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail