Browse Source

checkstyle - mostly javadoc

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277905 13f79535-47bb-0310-9956-ffa450edef68
master
Peter Reilly 20 years ago
parent
commit
4eff7a9987
8 changed files with 93 additions and 7 deletions
  1. +1
    -0
      src/main/org/apache/tools/ant/taskdefs/ExecTask.java
  2. +5
    -1
      src/main/org/apache/tools/ant/taskdefs/ExecuteStreamHandler.java
  3. +2
    -1
      src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java
  4. +1
    -1
      src/main/org/apache/tools/ant/taskdefs/Expand.java
  5. +9
    -1
      src/main/org/apache/tools/ant/taskdefs/Filter.java
  6. +8
    -1
      src/main/org/apache/tools/ant/taskdefs/GUnzip.java
  7. +49
    -0
      src/main/org/apache/tools/ant/taskdefs/GenerateKey.java
  8. +18
    -2
      src/main/org/apache/tools/ant/taskdefs/JDBCTask.java

+ 1
- 0
src/main/org/apache/tools/ant/taskdefs/ExecTask.java View File

@@ -289,6 +289,7 @@ public class ExecTask extends Task {
/** /**
* Indicates whether to attempt to resolve the executable to a * Indicates whether to attempt to resolve the executable to a
* file. * file.
* @return the resolveExecutable flag
* *
* @since Ant 1.6 * @since Ant 1.6
*/ */


+ 5
- 1
src/main/org/apache/tools/ant/taskdefs/ExecuteStreamHandler.java View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2000,2002,2004 The Apache Software Foundation
* Copyright 2000,2002,2004-2005 The Apache Software Foundation
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@ public interface ExecuteStreamHandler {
* *
* @param os output stream to write to the standard input stream of the * @param os output stream to write to the standard input stream of the
* subprocess * subprocess
* @throws IOException on error
*/ */
void setProcessInputStream(OutputStream os) throws IOException; void setProcessInputStream(OutputStream os) throws IOException;


@@ -41,6 +42,7 @@ public interface ExecuteStreamHandler {
* Install a handler for the error stream of the subprocess. * Install a handler for the error stream of the subprocess.
* *
* @param is input stream to read from the error stream from the subprocess * @param is input stream to read from the error stream from the subprocess
* @throws IOException on error
*/ */
void setProcessErrorStream(InputStream is) throws IOException; void setProcessErrorStream(InputStream is) throws IOException;


@@ -48,11 +50,13 @@ public interface ExecuteStreamHandler {
* Install a handler for the output stream of the subprocess. * Install a handler for the output stream of the subprocess.
* *
* @param is input stream to read from the error stream from the subprocess * @param is input stream to read from the error stream from the subprocess
* @throws IOException on error
*/ */
void setProcessOutputStream(InputStream is) throws IOException; void setProcessOutputStream(InputStream is) throws IOException;


/** /**
* Start handling of the streams. * Start handling of the streams.
* @throws IOException on error
*/ */
void start() throws IOException; void start() throws IOException;




+ 2
- 1
src/main/org/apache/tools/ant/taskdefs/ExecuteWatchdog.java View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2000-2004 The Apache Software Foundation
* Copyright 2000-2005 The Apache Software Foundation
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -107,6 +107,7 @@ public class ExecuteWatchdog implements TimeoutObserver {


/** /**
* Called after watchdog has finished. * Called after watchdog has finished.
* @param w the watchdog
*/ */
public void timeoutOccured(Watchdog w) { public void timeoutOccured(Watchdog w) {
try { try {


+ 1
- 1
src/main/org/apache/tools/ant/taskdefs/Expand.java View File

@@ -63,7 +63,7 @@ public class Expand extends Task {
private String encoding = "UTF8"; private String encoding = "UTF8";
/** Error message when more that one mapper is defined */ /** Error message when more that one mapper is defined */
public static final String ERROR_MULTIPLE_MAPPERS = "Cannot define more than one mapper"; public static final String ERROR_MULTIPLE_MAPPERS = "Cannot define more than one mapper";
private static final FileUtils FILE_UTILS = FileUtils.getFileUtils(); private static final FileUtils FILE_UTILS = FileUtils.getFileUtils();


/** /**


+ 9
- 1
src/main/org/apache/tools/ant/taskdefs/Filter.java View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2000-2004 The Apache Software Foundation
* Copyright 2000-2005 The Apache Software Foundation
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -63,6 +63,10 @@ public class Filter extends Task {
this.filtersFile = filtersFile; this.filtersFile = filtersFile;
} }


/**
* Execute the task.
* @throws BuildException on error
*/
public void execute() throws BuildException { public void execute() throws BuildException {
boolean isFiltersFromFile = boolean isFiltersFromFile =
filtersFile != null && token == null && value == null; filtersFile != null && token == null && value == null;
@@ -84,6 +88,10 @@ public class Filter extends Task {
} }
} }


/**
* Read the filters.
* @throws BuildException on error
*/
protected void readFilters() throws BuildException { protected void readFilters() throws BuildException {
log("Reading filters from " + filtersFile, Project.MSG_VERBOSE); log("Reading filters from " + filtersFile, Project.MSG_VERBOSE);
getProject().getGlobalFilterSet().readFiltersFromFile(filtersFile); getProject().getGlobalFilterSet().readFiltersFromFile(filtersFile);


+ 8
- 1
src/main/org/apache/tools/ant/taskdefs/GUnzip.java View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2000-2002,2004 The Apache Software Foundation
* Copyright 2000-2002,2004-2005 The Apache Software Foundation
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -37,10 +37,17 @@ public class GUnzip extends Unpack {


private static final String DEFAULT_EXTENSION = ".gz"; private static final String DEFAULT_EXTENSION = ".gz";


/**
* Get the default extension.
* @return the value ".gz"
*/
protected String getDefaultExtension() { protected String getDefaultExtension() {
return DEFAULT_EXTENSION; return DEFAULT_EXTENSION;
} }


/**
* Implement the gunzipping.
*/
protected void extract() { protected void extract() {
if (source.lastModified() > dest.lastModified()) { if (source.lastModified() > dest.lastModified()) {
log("Expanding " + source.getAbsolutePath() + " to " log("Expanding " + source.getAbsolutePath() + " to "


+ 49
- 0
src/main/org/apache/tools/ant/taskdefs/GenerateKey.java View File

@@ -32,30 +32,57 @@ import org.apache.tools.ant.util.JavaEnvUtils;
*/ */
public class GenerateKey extends Task { public class GenerateKey extends Task {


/**
* A DistinguishedName parameter.
* This is a nested element in a dname nested element.
*/
public static class DnameParam { public static class DnameParam {
private String name; private String name;
private String value; private String value;


/**
* Set the name attribute.
* @param name a <code>String</code> value
*/
public void setName(String name) { public void setName(String name) {
this.name = name; this.name = name;
} }


/**
* Get the name attribute.
* @return the name.
*/
public String getName() { public String getName() {
return name; return name;
} }


/**
* Set the value attribute.
* @param value a <code>String</code> value
*/
public void setValue(String value) { public void setValue(String value) {
this.value = value; this.value = value;
} }


/**
* Get the value attribute.
* @return the value.
*/
public String getValue() { public String getValue() {
return value; return value;
} }
} }


/**
* A class corresponding to the dname nested element.
*/
public static class DistinguishedName { public static class DistinguishedName {
private Vector params = new Vector(); private Vector params = new Vector();


/**
* Create a param nested element.
* @return a DnameParam object to be configured.
*/
public Object createParam() { public Object createParam() {
DnameParam param = new DnameParam(); DnameParam param = new DnameParam();
params.addElement(param); params.addElement(param);
@@ -63,10 +90,21 @@ public class GenerateKey extends Task {
return param; return param;
} }


/**
* Get the nested parameters.
* @return an enumeration of the nested parameters.
*/
public Enumeration getParams() { public Enumeration getParams() {
return params.elements(); return params.elements();
} }


/**
* Generate a string rep of this distinguished name.
* The format is each of the parameters (name = value)
* separated by ','.
* This is used on the command line.
* @return a string rep of this name
*/
public String toString() { public String toString() {
final int size = params.size(); final int size = params.size();
final StringBuffer sb = new StringBuffer(); final StringBuffer sb = new StringBuffer();
@@ -87,6 +125,13 @@ public class GenerateKey extends Task {
return sb.toString(); return sb.toString();
} }


/**
* Encode a name or value.
* The encoded result is the same as the input string
* except that each ',' is replaced by a '\,'.
* @param string the value to be encoded
* @return the encoded value.
*/
public String encode(final String string) { public String encode(final String string) {
int end = string.indexOf(','); int end = string.indexOf(',');


@@ -264,6 +309,10 @@ public class GenerateKey extends Task {
this.verbose = verbose; this.verbose = verbose;
} }


/**
* Execute the task.
* @throws BuildException on error
*/
public void execute() throws BuildException { public void execute() throws BuildException {


if (null == alias) { if (null == alias) {


+ 18
- 2
src/main/org/apache/tools/ant/taskdefs/JDBCTask.java View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2004 The Apache Software Foundation
* Copyright 2002-2005 The Apache Software Foundation
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -151,7 +151,7 @@ public abstract class JDBCTask extends Task {
* Caching loaders / driver. This is to avoid * Caching loaders / driver. This is to avoid
* getting an OutOfMemoryError when calling this task * getting an OutOfMemoryError when calling this task
* multiple times in a row; default: true * multiple times in a row; default: true
* @param enable
* @param enable a <code>boolean</code> value
*/ */
public void setCaching(boolean enable) { public void setCaching(boolean enable) {
caching = enable; caching = enable;
@@ -159,6 +159,7 @@ public abstract class JDBCTask extends Task {


/** /**
* Add a path to the classpath for loading the driver. * Add a path to the classpath for loading the driver.
* @return a path to be configured
*/ */
public Path createClasspath() { public Path createClasspath() {
if (this.classpath == null) { if (this.classpath == null) {
@@ -170,6 +171,7 @@ public abstract class JDBCTask extends Task {
/** /**
* Set the classpath for loading the driver * Set the classpath for loading the driver
* using the classpath reference. * using the classpath reference.
* @param r a reference to a classpath
*/ */
public void setClasspathRef(Reference r) { public void setClasspathRef(Reference r) {
createClasspath().setRefid(r); createClasspath().setRefid(r);
@@ -228,6 +230,8 @@ public abstract class JDBCTask extends Task {


/** /**
* Verify we are connected to the correct RDBMS * Verify we are connected to the correct RDBMS
* @param conn the jdbc connection
* @return true if we are connected to the correct RDBMS
*/ */
protected boolean isValidRdbms(Connection conn) { protected boolean isValidRdbms(Connection conn) {
if (rdbms == null && version == null) { if (rdbms == null && version == null) {
@@ -268,10 +272,18 @@ public abstract class JDBCTask extends Task {
return true; return true;
} }


/**
* Get the cache of loaders and drivers.
* @return a hashtable
*/
protected static Hashtable getLoaderMap() { protected static Hashtable getLoaderMap() {
return loaderMap; return loaderMap;
} }


/**
* Get the classloader used to create a driver.
* @return the classloader
*/
protected AntClassLoader getLoader() { protected AntClassLoader getLoader() {
return loader; return loader;
} }
@@ -380,6 +392,10 @@ public abstract class JDBCTask extends Task {
} }




/**
* Set the caching attribute. (!)
* @param value a <code>boolean</code> value
*/
public void isCaching(boolean value) { public void isCaching(boolean value) {
caching = value; caching = value;
} }


Loading…
Cancel
Save