org.apache.tools.ant.taskdefs

Class MakeUrl

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

static String
ERROR_MISSING_FILE
Missing file
static String
ERROR_NO_FILES
No files defined
static String
ERROR_NO_PROPERTY
No property defined

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

Method Summary

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 org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, 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, log, log, setDescription, setLocation, setProject

Field Details

ERROR_MISSING_FILE

public static final String ERROR_MISSING_FILE
Missing file

ERROR_NO_FILES

public static final String ERROR_NO_FILES
No files defined

ERROR_NO_PROPERTY

public static final String ERROR_NO_PROPERTY
No property defined

Method Details

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.

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 interface Task
Throws:
BuildException - if something goes wrong with the build

setFile

public void setFile(File file)
the name of a file to be converted into a URL
Parameters:
file - the file to be converted.

setProperty

public void setProperty(String property)
set the name of a property to fill with the URL
Parameters:
property - the name of the property.

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.