peterreilly 2005/07/08 06:33:02
Modified: src/main/org/apache/tools/ant/taskdefs/optional/ssh Scp.java
Log:
javadoc
Revision Changes Path
1.20 +17 -2
ant/src/main/org/apache/tools/ant/taskdefs/optional/ssh/Scp.java
Index: Scp.java
===================================================================
RCS file:
/home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/ssh/Scp.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- Scp.java 22 Nov 2004 09:23:34 -0000 1.19
+++ Scp.java 8 Jul 2005 13:33:01 -0000 1.20
@@ -1,5 +1,5 @@
/*
- * Copyright 2003-2004 The Apache Software Foundation
+ * Copyright 2003-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.
@@ -77,6 +77,7 @@
* Similiar to [EMAIL PROTECTED] #setFile setFile} but explicitly states
that
* the file is a local file. This is the only way to specify a
* local file with a @ character.
+ * @param aFromUri a string representing the source of the copy.
* @since Ant 1.6.2
*/
public void setLocalFile(String aFromUri) {
@@ -87,6 +88,7 @@
/**
* Similiar to [EMAIL PROTECTED] #setFile setFile} but explicitly states
that
* the file is a remote file.
+ * @param aFromUri a string representing the source of the copy.
* @since Ant 1.6.2
*/
public void setRemoteFile(String aFromUri) {
@@ -98,6 +100,7 @@
* Similiar to [EMAIL PROTECTED] #setTodir setTodir} but explicitly
states
* that the directory is a local. This is the only way to specify
* a local directory with a @ character.
+ * @param aToUri a string representing the target of the copy.
* @since Ant 1.6.2
*/
public void setLocalTodir(String aToUri) {
@@ -108,6 +111,7 @@
/**
* Similiar to [EMAIL PROTECTED] #setTodir setTodir} but explicitly
states
* that the directory is a remote.
+ * @param aToUri a string representing the target of the copy.
* @since Ant 1.6.2
*/
public void setRemoteTodir(String aToUri) {
@@ -118,6 +122,7 @@
/**
* Changes the file name to the given name while receiving it,
* only useful if receiving a single file.
+ * @param aToUri a string representing the target of the copy.
* @since Ant 1.6.2
*/
public void setLocalTofile(String aToUri) {
@@ -128,6 +133,7 @@
/**
* Changes the file name to the given name while sending it,
* only useful if sending a single file.
+ * @param aToUri a string representing the target of the copy.
* @since Ant 1.6.2
*/
public void setRemoteTofile(String aToUri) {
@@ -148,6 +154,10 @@
fileSets.add(set);
}
+ /**
+ * Initialize this task.
+ * @throws BuildException on error
+ */
public void init() throws BuildException {
super.init();
this.toUri = null;
@@ -155,6 +165,10 @@
this.fileSets = null;
}
+ /**
+ * Execute this task.
+ * @throws BuildException on error
+ */
public void execute() throws BuildException {
if (toUri == null) {
throw new BuildException("Either 'todir' or 'tofile' attribute "
@@ -176,7 +190,8 @@
upload(fromUri, toUri);
}
} else if (isFromRemote && isToRemote) {
- throw new BuildException("Copying from a remote server to a
remote server is not supported.");
+ throw new BuildException(
+ "Copying from a remote server to a remote server is not
supported.");
} else {
throw new BuildException("'todir' and 'file' attributes "
+ "must have syntax like the following: "
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
