Class MakeUrl

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.MakeUrl

All Implemented Interfaces:

Cloneable

public class MakeUrl
extends Task

This task takes file and turns them into a URL, which it then assigns to a property. Use when for setting up RMI codebases.

nested filesets are supported; if present, these are turned into the url with the given separator between them (default = " ").

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ERROR_MISSING_FILE	Missing file
static final String	ERROR_NO_FILES	No files defined
static final String	ERROR_NO_PROPERTY	No property defined

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
MakeUrl()

Method Summary

Modifier and Type	Method	Description
void	addFileSet(FileSet fileset)	a fileset of jar files to include in the URL, each separated by the separator
void	addPath(Path path)	add a path to the URL.
void	execute()	Create the url
void	setFile(File file)	the name of a file to be converted into a URL
void	setProperty(String property)	set the name of a property to fill with the URL
void	setSeparator(String separator)	set the separator for the multi-url option.
void	setValidate(boolean validate)	set this flag to trigger validation that every named file exists.

Methods inherited from class Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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.
void	init()	Called by the project to let the task initialize properly.
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

Field Details

ERROR_MISSING_FILE

public static final String ERROR_MISSING_FILE

Missing file

See Also:

• Constant Field Values

ERROR_NO_PROPERTY

public static final String ERROR_NO_PROPERTY

No property defined

See Also:

• Constant Field Values

ERROR_NO_FILES

public static final String ERROR_NO_FILES

No files defined

See Also:

• Constant Field Values

Constructor Details

MakeUrl

public MakeUrl()

Method Details

setProperty

public void setProperty(String property)

set the name of a property to fill with the URL

Parameters:

property - the name of the property.

setFile

public void setFile(File file)

the name of a file to be converted into a URL

Parameters:

file - the file to be converted.

addFileSet

public void addFileSet(FileSet fileset)

a fileset of jar files to include in the URL, each separated by the separator

Parameters:

fileset - the fileset to be added.

setSeparator

public void setSeparator(String separator)

set the separator for the multi-url option.

Parameters:

separator - the separator to use.

setValidate

public void setValidate(boolean validate)

set this flag to trigger validation that every named file exists. Optional: default=true

Parameters:

validate - a boolean value.

addPath

public void addPath(Path path)

add a path to the URL. All elements in the path will be converted to individual URL entries

Parameters:

path - a path value.

execute

public void execute()
             throws BuildException

Create the url

Overrides:

execute in class Task

Throws:

BuildException - if something goes wrong with the build