JarLibResolveTask (Apache Ant API)
Description: declaration: package: org.apache.tools.ant.taskdefs.optional.extension, class: JarLibResolveTask

# Class JarLibResolveTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask

All Implemented Interfaces:
  `Cloneable`

public class JarLibResolveTask extends Task
Tries to locate a JAR to satisfy an extension and place location of JAR into property.

- ## Field Summary

  ### 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
  `JarLibResolveTask()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addConfiguredAnt(AntResolver ant)`
  Adds Ant resolver to run an Ant build file to generate a library.
  `void`
  `addConfiguredExtension(ExtensionAdapter extension)`
  Set the Extension looking for.
  `void`
  `addConfiguredLocation(LocationResolver loc)`
  Adds location resolver to look for a library in a location relative to project directory.
  `void`
  `addConfiguredUrl(URLResolver url)`
  Adds a URL resolver to download a library from a URL to a local file.
  `void`
  `execute()`
  Execute the task.
  `void`
  `setCheckExtension(boolean checkExtension)`
  Check nested libraries for extensions
  `void`
  `setFailOnError(boolean failOnError)`
  Set whether to fail if error.
  `void`
  `setProperty(String property)`
  The name of the property in which the location of library is stored.

  ### 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`

- ## Constructor Details

  - ### JarLibResolveTask

    public JarLibResolveTask()

- ## Method Details

  - ### setProperty

    public void setProperty(String property)
    The name of the property in which the location of library is stored.
    Parameters:
      `property` - The name of the property in which the location of library is stored.

  - ### setCheckExtension

    public void setCheckExtension(boolean checkExtension)
    Check nested libraries for extensions
    Parameters:
      `checkExtension` - if true, libraries returned by nested resolvers should be checked to see if they supply extension.

  - ### setFailOnError

    public void setFailOnError(boolean failOnError)
    Set whether to fail if error.
    Parameters:
      `failOnError` - if true, failure to locate library should fail build.

  - ### addConfiguredLocation

    public void addConfiguredLocation(LocationResolver loc)
    Adds location resolver to look for a library in a location relative to project directory.
    Parameters:
      `loc` - the resolver location to search.

  - ### addConfiguredUrl

    public void addConfiguredUrl(URLResolver url)
    Adds a URL resolver to download a library from a URL to a local file.
    Parameters:
      `url` - the URL resolver from which to download the library

  - ### addConfiguredAnt

    public void addConfiguredAnt(AntResolver ant)
    Adds Ant resolver to run an Ant build file to generate a library.
    Parameters:
      `ant` - the AntResolver to generate the library.

  - ### addConfiguredExtension

    public void addConfiguredExtension(ExtensionAdapter extension)
    Set the Extension looking for.
    Parameters:
      `extension` - Set the Extension looking for.

  - ### execute

    public void execute() throws BuildException
    Execute the task.
    Overrides:
      `execute` in class `Task`
    Throws:
      `BuildException` - if the task fails.