ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From peterrei...@apache.org
Subject cvs commit: ant/src/main/org/apache/tools/ant/taskdefs/optional/condition IsPingable.java
Date Fri, 28 Jan 2005 11:29:16 GMT
peterreilly    2005/01/28 03:29:16

  Modified:    src/main/org/apache/tools/ant/taskdefs/optional/condition
                        IsPingable.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.4       +11 -6     ant/src/main/org/apache/tools/ant/taskdefs/optional/condition/IsPingable.java
  
  Index: IsPingable.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/taskdefs/optional/condition/IsPingable.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IsPingable.java	22 Nov 2004 09:23:32 -0000	1.3
  +++ IsPingable.java	28 Jan 2005 11:29:16 -0000	1.4
  @@ -1,5 +1,5 @@
   /*
  - * Copyright  2004 The Apache Software Foundation
  + * Copyright  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.
  @@ -40,24 +40,29 @@
   public class IsPingable extends ProjectComponent implements Condition  {
   
       private String host;
  +    /** The default timeout. */
       public static final int DEFAULT_TIMEOUT = 30;
       private int timeout = DEFAULT_TIMEOUT;
  +    /** Error when no hostname is defined */
       public static final String ERROR_NO_HOSTNAME = "No hostname defined";
  +    /** Error when invalid timeout value is defined */
       public static final String ERROR_BAD_TIMEOUT = "Invalid timeout value";
  +    /** Unknown host message is seen. */
       public static final String ERROR_UNKNOWN_HOST = "Unknown host:";
  +    /** Network error message is seen. */
       public static final String ERROR_ON_NETWORK = "network error to ";
   
       /**
  -     * the host to ping
  -     * @param host
  +     * The host to ping.
  +     * @param host the host to ping.
        */
       public void setHost(String host) {
           this.host = host;
       }
   
       /**
  -     * timeout for the reachability test -in seconds
  -     * @param timeout
  +     * Timeout for the reachability test -in seconds.
  +     * @param timeout the timeout in seconds.
        */
       public void setTimeout(int timeout) {
           this.timeout = timeout;
  @@ -66,7 +71,7 @@
       /**
        * Is this condition true?
        *
  -     * @return true if the condition is true
  +     * @return true if the condition is true.
        * @throws org.apache.tools.ant.BuildException
        *          if an error occurs
        */
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@ant.apache.org
For additional commands, e-mail: dev-help@ant.apache.org


Mime
View raw message