From 68e66cfb34bb29aeb294c9897cc6536deb72eb64 Mon Sep 17 00:00:00 2001
From: Peter Reilly <peterreilly@apache.org>
Date: Mon, 14 Mar 2005 11:46:56 +0000
Subject: [PATCH] javadoc + linelength

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277938 13f79535-47bb-0310-9956-ffa450edef68
---
 .../org/apache/tools/ant/taskdefs/Unpack.java | 21 +++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/src/main/org/apache/tools/ant/taskdefs/Unpack.java b/src/main/org/apache/tools/ant/taskdefs/Unpack.java
index 85093465f..0ed834536 100644
--- a/src/main/org/apache/tools/ant/taskdefs/Unpack.java
+++ b/src/main/org/apache/tools/ant/taskdefs/Unpack.java
@@ -1,5 +1,5 @@
 /*
- * Copyright  2001-2002,2004 The Apache Software Foundation
+ * Copyright  2001-2002,2004-2005 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -39,6 +39,7 @@ public abstract class Unpack extends Task {
      *             mechanism do the work and also to encapsulate operations on
      *             the type in its own class.
      * @ant.attribute ignore="true"
+     * @param src a <code>String</code> value
      */
     public void setSrc(String src) {
         log("DEPRECATED - The setSrc(String) method has been deprecated."
@@ -52,6 +53,7 @@ public abstract class Unpack extends Task {
      *             mechanism do the work and also to encapsulate operations on
      *             the type in its own class.
      * @ant.attribute ignore="true"
+     * @param dest a <code>String</code> value
      */
     public void setDest(String dest) {
         log("DEPRECATED - The setDest(String) method has been deprecated."
@@ -103,7 +105,8 @@ public abstract class Unpack extends Task {
         int len = sourceName.length();
         if (defaultExtension != null
             && len > defaultExtension.length()
-            && defaultExtension.equalsIgnoreCase(sourceName.substring(len - defaultExtension.length()))) {
+            && defaultExtension.equalsIgnoreCase(
+                sourceName.substring(len - defaultExtension.length()))) {
             dest = new File(dest, sourceName.substring(0,
                                                        len - defaultExtension.length()));
         } else {
@@ -111,6 +114,10 @@ public abstract class Unpack extends Task {
         }
     }
 
+    /**
+     * Execute the task.
+     * @throws BuildException on error
+     */
     public void execute() throws BuildException {
         File savedDest = dest; // may be altered in validate
         try {
@@ -121,6 +128,16 @@ public abstract class Unpack extends Task {
         }
     }
 
+    /**
+     * Get the extension.
+     * This is to be overridden by subclasses.
+     * @return the default extension.
+     */
     protected abstract String getDefaultExtension();
+
+    /**
+     * Do the uncompressing.
+     * This is to be overridden by subclasses.
+     */
     protected abstract void extract();
 }