Browse Source

No more deprecated warnings for aliased attributes of oft-used zip, jar, war and ear tasks.

Conor, Costin and I voted +1
Stefan voted +0

However, there is *no* guarantee that all these aliases will stay for Ant2.  DestFile is currently the most promising attribute name to be carried over to Ant2.

I have left the @deprecated tags in there and haven't touched javadoc also.


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271847 13f79535-47bb-0310-9956-ffa450edef68
master
Magesh Umasankar 23 years ago
parent
commit
060c35544e
4 changed files with 28 additions and 34 deletions
  1. +14
    -15
      src/main/org/apache/tools/ant/taskdefs/Ear.java
  2. +0
    -1
      src/main/org/apache/tools/ant/taskdefs/Jar.java
  3. +13
    -14
      src/main/org/apache/tools/ant/taskdefs/War.java
  4. +1
    -4
      src/main/org/apache/tools/ant/taskdefs/Zip.java

+ 14
- 15
src/main/org/apache/tools/ant/taskdefs/Ear.java View File

@@ -1,7 +1,7 @@
/* /*
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
* *
* Copyright (c) 2001-2002 The Apache Software Foundation. All rights
* Copyright (c) 2001-2002 The Apache Software Foundation. All rights
* reserved. * reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@@ -9,7 +9,7 @@
* are met: * are met:
* *
* 1. Redistributions of source code must retain the above copyright * 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* notice, this list of conditions and the following disclaimer.
* *
* 2. Redistributions in binary form must reproduce the above copyright * 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in * notice, this list of conditions and the following disclaimer in
@@ -17,15 +17,15 @@
* distribution. * distribution.
* *
* 3. The end-user documentation included with the redistribution, if * 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)." * Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself, * Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear. * if and wherever such third-party acknowlegements normally appear.
* *
* 4. The names "The Jakarta Project", "Ant", and "Apache Software * 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived * Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* from this software without prior written permission. For written
* permission, please contact apache@apache.org. * permission, please contact apache@apache.org.
* *
* 5. Products derived from this software may not be called "Apache" * 5. Products derived from this software may not be called "Apache"
@@ -64,16 +64,16 @@ import java.io.IOException;


/** /**
* Creates a EAR archive. Based on WAR task * Creates a EAR archive. Based on WAR task
*
* @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
* @author <a href="mailto:leslie.hughes@rubus.com">Les Hughes</a>
*
* @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
* @author <a href="mailto:leslie.hughes@rubus.com">Les Hughes</a>
* *
* @ant.task category="packaging" * @ant.task category="packaging"
*/ */
public class Ear extends Jar { public class Ear extends Jar {


private File deploymentDescriptor; private File deploymentDescriptor;
private boolean descriptorAdded;
private boolean descriptorAdded;


public Ear() { public Ear() {
super(); super();
@@ -83,17 +83,16 @@ public class Ear extends Jar {


/** /**
* @deprecated Use setDestFile(destfile) instead * @deprecated Use setDestFile(destfile) instead
*/
*/
public void setEarfile(File earFile) { public void setEarfile(File earFile) {
log("DEPRECATED - The earfile attribute is deprecated. Use destfile attribute instead.");
setDestFile(earFile); setDestFile(earFile);
} }
/** /**
* set the application XML file * set the application XML file
*/ */
public void setAppxml(File descr) { public void setAppxml(File descr) {
deploymentDescriptor = descr;
deploymentDescriptor = descr;
if (!deploymentDescriptor.exists()) { if (!deploymentDescriptor.exists()) {
throw new BuildException("Deployment descriptor: " + deploymentDescriptor + " does not exist."); throw new BuildException("Deployment descriptor: " + deploymentDescriptor + " does not exist.");
} }
@@ -123,7 +122,7 @@ public class Ear extends Jar {
if (deploymentDescriptor == null && !isInUpdateMode()) { if (deploymentDescriptor == null && !isInUpdateMode()) {
throw new BuildException("appxml attribute is required", location); throw new BuildException("appxml attribute is required", location);
} }
super.initZipOutputStream(zOut); super.initZipOutputStream(zOut);
} }


@@ -131,7 +130,7 @@ public class Ear extends Jar {
throws IOException throws IOException
{ {
// If the file being added is META-INF/application.xml, we warn if it's not the // If the file being added is META-INF/application.xml, we warn if it's not the
// one specified in the "appxml" attribute - or if it's being added twice,
// one specified in the "appxml" attribute - or if it's being added twice,
// meaning the same file is specified by the "appxml" attribute and in // meaning the same file is specified by the "appxml" attribute and in
// a <fileset> element. // a <fileset> element.
if (vPath.equalsIgnoreCase("META-INF/application.xml")) { if (vPath.equalsIgnoreCase("META-INF/application.xml")) {


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

@@ -134,7 +134,6 @@ public class Jar extends Zip {
* @deprecated Use setDestFile(File) instead * @deprecated Use setDestFile(File) instead
*/ */
public void setJarfile(File jarFile) { public void setJarfile(File jarFile) {
log("DEPRECATED - The jarfile attribute is deprecated. Use destfile attribute instead.");
setDestFile(jarFile); setDestFile(jarFile);
} }




+ 13
- 14
src/main/org/apache/tools/ant/taskdefs/War.java View File

@@ -1,7 +1,7 @@
/* /*
* The Apache Software License, Version 1.1 * The Apache Software License, Version 1.1
* *
* Copyright (c) 2000-2002 The Apache Software Foundation. All rights
* Copyright (c) 2000-2002 The Apache Software Foundation. All rights
* reserved. * reserved.
* *
* Redistribution and use in source and binary forms, with or without * Redistribution and use in source and binary forms, with or without
@@ -9,7 +9,7 @@
* are met: * are met:
* *
* 1. Redistributions of source code must retain the above copyright * 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* notice, this list of conditions and the following disclaimer.
* *
* 2. Redistributions in binary form must reproduce the above copyright * 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in * notice, this list of conditions and the following disclaimer in
@@ -17,15 +17,15 @@
* distribution. * distribution.
* *
* 3. The end-user documentation included with the redistribution, if * 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)." * Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself, * Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear. * if and wherever such third-party acknowlegements normally appear.
* *
* 4. The names "The Jakarta Project", "Ant", and "Apache Software * 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived * Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* from this software without prior written permission. For written
* permission, please contact apache@apache.org. * permission, please contact apache@apache.org.
* *
* 5. Products derived from this software may not be called "Apache" * 5. Products derived from this software may not be called "Apache"
@@ -65,15 +65,15 @@ import java.io.IOException;


/** /**
* Creates a WAR archive. * Creates a WAR archive.
*
* @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
*
* @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
* *
* @ant.task category="packaging" * @ant.task category="packaging"
*/ */
public class War extends Jar { public class War extends Jar {


private File deploymentDescriptor; private File deploymentDescriptor;
private boolean descriptorAdded;
private boolean descriptorAdded;


public War() { public War() {
super(); super();
@@ -83,17 +83,16 @@ public class War extends Jar {


/** /**
* @deprecated Use setDestFile(File) instead * @deprecated Use setDestFile(File) instead
*/
*/
public void setWarfile(File warFile) { public void setWarfile(File warFile) {
log("DEPRECATED - The warfile attribute is deprecated. Use destfile attribute instead.");
setDestFile(warFile); setDestFile(warFile);
} }
/** /**
* set the web app descriptor for this WAR file * set the web app descriptor for this WAR file
*/ */
public void setWebxml(File descr) { public void setWebxml(File descr) {
deploymentDescriptor = descr;
deploymentDescriptor = descr;
if (!deploymentDescriptor.exists()) { if (!deploymentDescriptor.exists()) {
throw new BuildException("Deployment descriptor: " + deploymentDescriptor + " does not exist."); throw new BuildException("Deployment descriptor: " + deploymentDescriptor + " does not exist.");
} }
@@ -131,7 +130,7 @@ public class War extends Jar {
if (deploymentDescriptor == null && !isInUpdateMode()) { if (deploymentDescriptor == null && !isInUpdateMode()) {
throw new BuildException("webxml attribute is required", location); throw new BuildException("webxml attribute is required", location);
} }
super.initZipOutputStream(zOut); super.initZipOutputStream(zOut);
} }


@@ -139,7 +138,7 @@ public class War extends Jar {
throws IOException throws IOException
{ {
// If the file being added is WEB-INF/web.xml, we warn if it's not the // If the file being added is WEB-INF/web.xml, we warn if it's not the
// one specified in the "webxml" attribute - or if it's being added twice,
// one specified in the "webxml" attribute - or if it's being added twice,
// meaning the same file is specified by the "webxml" attribute and in // meaning the same file is specified by the "webxml" attribute and in
// a <fileset> element. // a <fileset> element.
if (vPath.equalsIgnoreCase("WEB-INF/web.xml")) { if (vPath.equalsIgnoreCase("WEB-INF/web.xml")) {


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

@@ -123,10 +123,9 @@ public class Zip extends MatchingTask {
* This is the name/location of where to * This is the name/location of where to
* create the .zip file. * create the .zip file.
* *
* @deprecated Use setDestFile(File) instead
* @deprecated Use setDestFile(File) instead.
*/ */
public void setZipfile(File zipFile) { public void setZipfile(File zipFile) {
log("DEPRECATED - The zipfile attribute is deprecated. Use destfile attribute instead.");
setDestFile(zipFile); setDestFile(zipFile);
} }


@@ -137,8 +136,6 @@ public class Zip extends MatchingTask {
* @deprecated Use setDestFile(File) instead * @deprecated Use setDestFile(File) instead
*/ */
public void setFile(File file) { public void setFile(File file) {
log("DEPRECATED - The file attribute has been renamed destfile.",
Project.MSG_ERR);
setDestFile(file); setDestFile(file);
} }




Loading…
Cancel
Save