+TypedefURIFix +

diff -r 7685cec9fd3c -r f2ddfa555b0f doc/api/java/com/nokia/ant/TypedefURIFix.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/api/java/com/nokia/ant/TypedefURIFix.html Fri Sep 11 11:54:49 2009 +0100 @@ -0,0 +1,834 @@ + + + + + + +TypedefURIFix + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + +

Overview

Package

Class

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +com.nokia.ant +
+Class TypedefURIFix

+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
+                      com.nokia.ant.TypedefURIFix
+

All Implemented Interfaces:: java.lang.Cloneable

public class TypedefURIFix
extends org.apache.tools.ant.taskdefs.Definer
extends org.apache.tools.ant.taskdefs.Definer

+ + +

+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 Summary
+static class TypedefURIFix.Format + +
+          Enumerated type for format attribute
+static class TypedefURIFix.OnError + +
+          Enumerated type for onError attribute
+ + + + + + + +
+Field Summary
+ + + + + + + + +
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
+ + + + + + + + +
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
+ + + + + + + + + + + +
+Constructor Summary
TypedefURIFix() + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected void addDefinition(java.lang.ClassLoader al, + java.lang.String name, + java.lang.String classname) + +
+          Add a definition using the attributes of Definer
+ void execute() + +
+          Run the definition.
+ java.lang.String getClassname() + +
+          Returns the classname of the object we are defining.
+ java.io.File getFile() + +
+
+ java.lang.String getName() + +
+
+ java.lang.String getResource() + +
+
+protected void loadProperties(java.lang.ClassLoader al, + java.net.URL url) + +
+          Load type definitions as properties from a URL.
+static java.lang.String makeResourceFromURI(java.lang.String uri) + +
+          This is where the logic to map from a URI to an antlib resource + is kept.
+ void setAdapter(java.lang.String adapter) + +
+          Set the class name of the adapter class.
+protected void setAdapterClass(java.lang.Class adapterClass) + +
+          Set the adapter class.
+ void setAdaptTo(java.lang.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(java.lang.Class adaptToClass) + +
+          Set the class for adaptToClass, to be + used by derived classes, used instead of + the adaptTo attribute.
+ void setAntlib(java.lang.String antlib) + +
+          Antlib attribute, sets resource and uri.
+ void setClassname(java.lang.String classname) + +
+          The full class name of the object being defined.
+ void setFile(java.io.File file) + +
+          Name of the property file to load + ant name/classname pairs from.
+ void setFormat(TypedefURIFix.Format format) + +
+          Sets the format of the file or resource
+ void setName(java.lang.String name) + +
+          Name of the definition
+ void setOnError(TypedefURIFix.OnError onError) + +
+          What to do if there is an error in loading the class.
+ void setResource(java.lang.String res) + +
+          Name of the property resource to load + ant name/classname pairs from.
+ + + + + + + + +
Methods inherited from class org.apache.tools.ant.taskdefs.Definer
setFormat, setOnError
+ + + + + + + + +
Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
+ + + + + + + + +
Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
+ + + + + + + + +
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
+ + + + + + + + +
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
+ + + + + + + + +
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ +

+Nested Class Summary
+`static class`	`TypedefURIFix.Format` + + + Enumerated type for format attribute
+`static class`	`TypedefURIFix.OnError` + + + Enumerated type for onError attribute

Fields inherited from class org.apache.tools.ant.Task
`target, taskName, taskType, wrapper`

Fields inherited from class org.apache.tools.ant.ProjectComponent
`description, location, project`

+Constructor Summary
`TypedefURIFix()` + + +

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

Methods inherited from class org.apache.tools.ant.taskdefs.Definer
`setFormat, setOnError`

Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
`createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader`

Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
`getAntlibClassLoader, getURI, setAntlibClassLoader, setURI`

Methods inherited from class org.apache.tools.ant.Task
`bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType`

Methods inherited from class org.apache.tools.ant.ProjectComponent
`clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

+ + + + + + + + +
+Constructor Detail
+ +

+TypedefURIFix

+public TypedefURIFix()

+ + + + + + + + + +

+Method Detail

+ +

+setOnError

+public void setOnError(TypedefURIFix.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 - an OnError value

+ +

+setFormat

+public void setFormat(TypedefURIFix.Format format)

Sets the format of the file or resource +

Parameters:: format - the enumerated value - xml or properties

+ +

+getName

+public java.lang.String getName()

Overrides:: getName in class org.apache.tools.ant.taskdefs.Definer

Returns:: the name for this definition

+ +

+getFile

+public java.io.File getFile()

Overrides:: getFile in class org.apache.tools.ant.taskdefs.Definer

Returns:: the file containing definitions

+ +

+getResource

+public java.lang.String getResource()

Overrides:: getResource in class org.apache.tools.ant.taskdefs.Definer

Returns:: the resource containing definitions

+ +

+execute

+public void execute()

Run the definition. +

Overrides:: execute in class org.apache.tools.ant.taskdefs.Definer

Throws: +: org.apache.tools.ant.BuildException - if an error occurs

+ +

+makeResourceFromURI

+public static java.lang.String makeResourceFromURI(java.lang.String uri)

This 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

+ +

+loadProperties

+protected void loadProperties(java.lang.ClassLoader al,
+                              java.net.URL url)

Load type definitions as properties from a URL. +

Overrides:: loadProperties in class org.apache.tools.ant.taskdefs.Definer

Parameters:: al - the classloader to use; url - the url to get the definitions from

+ +

+setFile

+public void setFile(java.io.File file)

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

Overrides:: setFile in class org.apache.tools.ant.taskdefs.Definer

Parameters:: file - the file

+ +

+setResource

+public void setResource(java.lang.String res)

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

Overrides:: setResource in class org.apache.tools.ant.taskdefs.Definer

Parameters:: res - the resource to use

+ +

+setAntlib

+public void setAntlib(java.lang.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". +

Overrides:: setAntlib in class org.apache.tools.ant.taskdefs.Definer

Parameters:: antlib - the value to set.

+ +

+setName

+public void setName(java.lang.String name)

Name of the definition +

Overrides:: setName in class org.apache.tools.ant.taskdefs.Definer

Parameters:: name - the name of the definition

+ +

+getClassname

+public java.lang.String getClassname()

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

Overrides:: getClassname in class org.apache.tools.ant.taskdefs.Definer

Returns:: the class name

+ +

+setClassname

+public void setClassname(java.lang.String classname)

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

Overrides:: setClassname in class org.apache.tools.ant.taskdefs.Definer

Parameters:: classname - the name of the class

+ +

+setAdapter

+public void setAdapter(java.lang.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. +

Overrides:: setAdapter in class org.apache.tools.ant.taskdefs.Definer

Parameters:: adapter - the name of the adapter class

+ +

+setAdapterClass

+protected void setAdapterClass(java.lang.Class adapterClass)

Set the adapter class. +

Overrides:: setAdapterClass in class org.apache.tools.ant.taskdefs.Definer

Parameters:: adapterClass - the class to use to adapt the definition class

+ +

+setAdaptTo

+public void setAdaptTo(java.lang.String adaptTo)

Set the classname of the class that the definition + must be compatible with, either directly or + by use of the adapter class. +

Overrides:: setAdaptTo in class org.apache.tools.ant.taskdefs.Definer

Parameters:: adaptTo - the name of the adaptto class

+ +

+setAdaptToClass

+protected void setAdaptToClass(java.lang.Class adaptToClass)

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

Overrides:: setAdaptToClass in class org.apache.tools.ant.taskdefs.Definer

Parameters:: adaptToClass - the class for adapto.

+ +

+addDefinition

+protected void addDefinition(java.lang.ClassLoader al,
+                             java.lang.String name,
+                             java.lang.String classname)

Add a definition using the attributes of Definer +

Overrides:: addDefinition in class org.apache.tools.ant.taskdefs.Definer

Parameters:: al - the ClassLoader to use; name - the name of the definition; classname - the classname of the definition +
Throws: +: org.apache.tools.ant.BuildException - if an error occurs

+ +