ball.util.ant.taskdefs

Interface ClasspathDelegateAntTask

All Superinterfaces:

AntTaskMixIn

All Known Implementing Classes:

CardTask, CardTask.PokerHandEvaluate, CombinationsTask, CombinationsTask.Count, CombinationsTask.Of, DownloadTask, DVDTask, DVDTask.Scan, HDHRDiscoverTask, HDHRPrimeClientTask, HDHRPrimeClientTask.Lineup, HDHRPrimeClientTask.Record, HDHRRecordingTask, HDHRRecordingTask.Metadata, HDHRTunerTask, HDHRTunerTask.Options, HDHRTunerTask.Scan, HTTPTask, HTTPTask.Delete, HTTPTask.Get, HTTPTask.Head, HTTPTask.Options, HTTPTask.Patch, HTTPTask.Post, HTTPTask.Put, HTTPTask.Request, InstanceOfTask, LifeTask, ObjectMapperTask, ObjectMapperTask.ReadValue, PermutationsTask, PermutationsTask.Count, PermutationsTask.Of, PersistenceTask, PersistenceTask.GenerateSchema, PersistenceTask.ListProviders, ProcessClassFilesTask, ScrabbleTask, ScrabbleTask.WordsFor, SDClientTask, SDClientTask.AutomapLineup, SDClientTask.Get, SDClientTask.GetAvailable, SDClientTask.GetAvailableCountries, SDClientTask.GetAvailableLanguages, SDClientTask.GetCelebrityMetadata, SDClientTask.GetHeadends, SDClientTask.GetImage, SDClientTask.GetLineups, SDClientTask.GetProgramMetadata, SDClientTask.GetPrograms, SDClientTask.GetPrograms.Description, SDClientTask.GetPrograms.Metadata, SDClientTask.GetSchedules, SDClientTask.GetSchedules.MD5, SDClientTask.GetStatus, SDClientTask.GetToken, SDClientTask.Intialize, SDClientTask.Lineup, SDClientTask.Lineup.Delete, SDClientTask.Lineup.Post, SDClientTask.Lineup.Put, SSDPDiscoverTask, SudokuTask, TypeTask, TypeTask.BeanInfoFor, TypeTask.IsAssignableFrom, TypeTask.MembersOf, TypeTask.ResourcePathTo, TypeTask.SuperclassesOf, XDTask, XDTask.Load, XDTask.Solve, XPathEvaluateTask

public interface ClasspathDelegateAntTask
extends AntTaskMixIn

Interface to provide common default methods for Tasks that implement the syntax described in ClasspathUtils.Delegate.

Version:

$Revision: 6074 $

Author:

Allen D. Ball

Method Summary

Modifier and Type	Method and Description
default Path	createClasspath() See ClasspathUtils.Delegate.createClasspath().
ClasspathUtils.Delegate	delegate() Required state for implementing Tasks.
ClasspathDelegateAntTask	delegate(ClasspathUtils.Delegate delegate) Required state for implementing Tasks.
default Class<?>	getClassForName(String name) Method to get the Class associated with the argument name using the ClassLoader provided by getClassLoader().
default AntClassLoader	getClassLoader() Method to get the AntClassLoader specified by this Task.
default void	init() Default implementation for Task subclasses.
default void	setClassname(String name) See ClasspathUtils.Delegate.setClassname(String).
default void	setClasspathref(Reference reference) See ClasspathUtils.Delegate.setClasspathref(Reference).

Method Detail

delegate

ClasspathUtils.Delegate delegate()

Required state for implementing Tasks. Refer to the discussion in ClasspathUtils.

Returns:

The ClasspathUtils.Delegate instance created in the Task.init() method.

delegate

ClasspathDelegateAntTask delegate(ClasspathUtils.Delegate delegate)

Required state for implementing Tasks. Refer to the discussion in ClasspathUtils.

Parameters:

delegate - The ClasspathUtils.Delegate.

Returns:

The this.

init

default void init()
           throws BuildException

Default implementation for Task subclasses.

Throws:

BuildException

setClasspathref

default void setClasspathref(Reference reference)

See ClasspathUtils.Delegate.setClasspathref(Reference).

Parameters:

reference - The Reference to the classpath.

createClasspath

default Path createClasspath()

See ClasspathUtils.Delegate.createClasspath().

Returns:

The created Path.

setClassname

default void setClassname(String name)

See ClasspathUtils.Delegate.setClassname(String).

Parameters:

name - The class name (String).

getClassLoader

default AntClassLoader getClassLoader()

Method to get the AntClassLoader specified by this Task.

Returns:

The AntClassLoader.

getClassForName

default Class<?> getClassForName(String name)
                          throws ClassNotFoundException

Method to get the Class associated with the argument name using the ClassLoader provided by getClassLoader().

Parameters:

name - The fully qualified name of the desired class.

Returns:

The Class for the specified name.

Throws:

ClassNotFoundException - If the Class is not found.