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

Package org.apache.tools.ant.taskdefs

# Class Unpack

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Unpack

All Implemented Interfaces:
  `Cloneable`

Direct Known Subclasses:
  `BUnzip2`, `GUnzip`, `Unxz`

public abstract class Unpack extends Task
Abstract Base class for unpack tasks.

Since:
  Ant 1.5

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `protected File`
  `dest`
  `protected File`
  `source`
  `protected Resource`
  `srcResource`

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

  Constructors
  Constructor
  Description
  `Unpack()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addConfigured(ResourceCollection a)`
  Set the source Archive resource.
  `void`
  `execute()`
  Execute the task.
  `protected abstract void`
  `extract()`
  Do the uncompressing.
  `protected abstract String`
  `getDefaultExtension()`
  Get the extension.
  `void`
  `setDest(File dest)`
  The destination file or directory; optional.
  `void`
  `setDest(String dest)`
  Deprecated.
  since 1.5.x.
  `void`
  `setSrc(File src)`
  The file to expand; required.
  `void`
  `setSrc(String src)`
  Deprecated.
  since 1.5.x.
  `void`
  `setSrcResource(Resource src)`
  The resource to expand; required.
  `protected boolean`
  `supportsNonFileResources()`
  Whether this task can deal with non-file resources.

  ### Methods inherited from class org.apache.tools.ant.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`

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

- ## Field Details

  - ### source

    protected File source

  - ### dest

    protected File dest

  - ### srcResource

    protected Resource srcResource

- ## Constructor Details

  - ### Unpack

    public Unpack()

- ## Method Details

  - ### setSrc

    @Deprecated public void setSrc(String src)
    Deprecated.
    since 1.5.x. setSrc(String) is deprecated and is replaced with setSrc(File) to make Ant's Introspection mechanism do the work and also to encapsulate operations on the type in its own class.
    Parameters:
      `src` - a `String` value

  - ### setDest

    @Deprecated public void setDest(String dest)
    Deprecated.
    since 1.5.x. setDest(String) is deprecated and is replaced with setDest(File) to make Ant's Introspection mechanism do the work and also to encapsulate operations on the type in its own class.
    Parameters:
      `dest` - a `String` value

  - ### setSrc

    public void setSrc(File src)
    The file to expand; required.
    Parameters:
      `src` - file to expand

  - ### setSrcResource

    public void setSrcResource(Resource src)
    The resource to expand; required.
    Parameters:
      `src` - resource to expand

  - ### addConfigured

    public void addConfigured(ResourceCollection a)
    Set the source Archive resource.
    Parameters:
      `a` - the archive as a single element Resource collection.

  - ### setDest

    public void setDest(File dest)
    The destination file or directory; optional.
    Parameters:
      `dest` - destination file or directory

  - ### execute

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

  - ### getDefaultExtension

    protected abstract String getDefaultExtension()
    Get the extension. This is to be overridden by subclasses.
    Returns:
      the default extension.

  - ### extract

    protected abstract void extract()
    Do the uncompressing. This is to be overridden by subclasses.

  - ### supportsNonFileResources

    protected boolean supportsNonFileResources()
    Whether this task can deal with non-file resources.

    This implementation returns false.

    Returns:
      false for this task.
    Since:
      Ant 1.7