ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mben...@apache.org
Subject cvs commit: ant/src/main/org/apache/tools/ant/types PropertySet.java
Date Wed, 19 Jan 2005 18:33:09 GMT
mbenson     2005/01/19 10:33:09

  Modified:    src/main/org/apache/tools/ant/types PropertySet.java
  Log:
  Javadoc
  
  Revision  Changes    Path
  1.23      +31 -32    ant/src/main/org/apache/tools/ant/types/PropertySet.java
  
  Index: PropertySet.java
  ===================================================================
  RCS file: /home/cvs/ant/src/main/org/apache/tools/ant/types/PropertySet.java,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- PropertySet.java	18 Jan 2005 10:00:27 -0000	1.22
  +++ PropertySet.java	19 Jan 2005 18:33:09 -0000	1.23
  @@ -49,7 +49,7 @@
       private Mapper mapper;
   
       /**
  -     * this is a nested class containing a reference to some properties
  +     * This is a nested class containing a reference to some properties
        * and optionally a source of properties.
        */
       public static class PropertyRef {
  @@ -62,7 +62,7 @@
   
           /**
            * Set the name.
  -         * @param name a <code>String</code> value
  +         * @param name a <code>String</code> value.
            */
           public void setName(String name) {
               assertValid("name", name);
  @@ -71,7 +71,7 @@
   
           /**
            * Set the regular expression to use to filter the properties.
  -         * @param regex a regular expression
  +         * @param regex a regular expression.
            */
           public void setRegex(String regex) {
               assertValid("regex", regex);
  @@ -80,7 +80,7 @@
   
           /**
            * Set the prefix to use.
  -         * @param prefix a <code>String</code> value
  +         * @param prefix a <code>String</code> value.
            */
           public void setPrefix(String prefix) {
               assertValid("prefix", prefix);
  @@ -89,7 +89,7 @@
   
           /**
            * Builtin property names - all, system or commandline.
  -         * @param b an enumerated <code>BuildinPropertySetName</code> value
  +         * @param b an enumerated <code>BuildinPropertySetName</code> value.
            */
           public void setBuiltin(BuiltinPropertySetName b) {
               String pBuiltIn = b.getValue();
  @@ -109,8 +109,8 @@
           }
   
           /**
  -         * a debug toString()
  -         * @return a string version of this object
  +         * A debug toString().
  +         * @return a string version of this object.
            */
           public String toString() {
               return "name=" + name + ", regex=" + regex + ", prefix=" + prefix
  @@ -121,7 +121,7 @@
   
       /**
        * Allow properties of a particular name in the set.
  -     * @param name the property name to allow
  +     * @param name the property name to allow.
        */
       public void appendName(String name) {
           PropertyRef r = new PropertyRef();
  @@ -131,7 +131,7 @@
   
       /**
        * Allow properties whose names match a regex in the set.
  -     * @param regex the regular expression to use
  +     * @param regex the regular expression to use.
        */
       public void appendRegex(String regex) {
           PropertyRef r = new PropertyRef();
  @@ -141,7 +141,7 @@
   
       /**
        * Allow properties whose names start with a prefix in the set.
  -     * @param prefix the prefix to use
  +     * @param prefix the prefix to use.
        */
       public void appendPrefix(String prefix) {
           PropertyRef r = new PropertyRef();
  @@ -151,7 +151,7 @@
   
       /**
        * Allow builtin (all, system or commandline) properties in the set.
  -     * @param b the type of builtin properties
  +     * @param b the type of builtin properties.
        */
       public void appendBuiltin(BuiltinPropertySetName b) {
           PropertyRef r = new PropertyRef();
  @@ -160,10 +160,10 @@
       }
   
       /**
  -     * set a mapper to change property names
  -     * @param type mapper type
  -     * @param from source pattern
  -     * @param to output pattern
  +     * Set a mapper to change property names.
  +     * @param type mapper type.
  +     * @param from source pattern.
  +     * @param to output pattern.
        */
       public void setMapper(String type, String from, String to) {
           Mapper mapper = createMapper();
  @@ -184,7 +184,7 @@
   
       /**
        * Add another property set to this set.
  -     * @param ref another property set
  +     * @param ref another property set.
        */
       public void addPropertyset(PropertySet ref) {
           assertNotReference();
  @@ -193,7 +193,7 @@
   
       /**
        * Create a mapper to map the property names.
  -     * @return a mapper to be configured
  +     * @return a mapper to be configured.
        */
       public Mapper createMapper() {
           assertNotReference();
  @@ -205,8 +205,8 @@
       }
   
       /**
  -     * A nested filenamemapper
  -     * @param fileNameMapper the mapper to add
  +     * Add a nested FileNameMapper.
  +     * @param fileNameMapper the mapper to add.
        * @since Ant 1.6.3
        */
       public void add(FileNameMapper fileNameMapper) {
  @@ -214,7 +214,7 @@
       }
   
       /**
  -     * Whether to reevaluate the set everytime the set is used.
  +     * Set whether to reevaluate the set everytime the set is used.
        * Default is true.
        *
        * @param dynamic if true, reevaluate the property set each time
  @@ -228,10 +228,10 @@
       }
   
       /**
  -     * Whether to negate results.
  +     * Set whether to negate results.
        * If "true", all properties not selected by nested elements will be returned.
  -     *  Default is "false"
  -     * @param negate if true, negate the selection criteria
  +     *  Default is "false".
  +     * @param negate if true, negate the selection criteria.
        */
       public void setNegate(boolean negate) {
           assertNotReference();
  @@ -240,7 +240,7 @@
   
       /**
        * Get the dynamic attribute.
  -     * @return true if the property set is to be evalulated each time it is used
  +     * @return true if the property set is to be evalulated each time it is used.
        */
       public boolean getDynamic() {
           return isReference() ? getRef().dynamic : dynamic;
  @@ -248,7 +248,7 @@
   
       /**
        * Get the mapper attribute.
  -     * @return the mapper attribute
  +     * @return the mapper attribute.
        */
       public Mapper getMapper() {
           return isReference() ? getRef().mapper : mapper;
  @@ -270,8 +270,8 @@
       }
   
       /**
  -     * this is the operation to get the existing or recalculated properties.
  -     * @return the properties for this propertyset
  +     * This is the operation to get the existing or recalculated properties.
  +     * @return the properties for this propertyset.
        */
       public Properties getProperties() {
           if (isReference()) {
  @@ -302,7 +302,6 @@
           } else {
               names = cachedNames;
           }
  -
           FileNameMapper mapper = null;
           Mapper myMapper = getMapper();
           if (myMapper != null) {
  @@ -380,7 +379,7 @@
       /**
        * Performs the check for circular references and returns the
        * referenced PropertySet.
  -     * @return the referenced PropertySet
  +     * @return the referenced PropertySet.
        */
       protected PropertySet getRef() {
           if (!isChecked()) {
  @@ -431,8 +430,8 @@
       }
   
       /**
  -     * flag which tracks whether any attribute has been set; used by
  -     * {@link #assertNotReference()} and {@link #setRefid(Reference)}
  +     * Flag which tracks whether any attribute has been set; used by
  +     * {@link #assertNotReference()} and {@link #setRefid(Reference)}.
        */
       private boolean noAttributeSet = true;
   
  @@ -454,7 +453,7 @@
        * This gets a comma separated list of key=value pairs for
        * the properties in the set.
        * The output order is sorted according to the keys' <i>natural order</i>.
  -     * @return a string rep of this object
  +     * @return a string rep of this object.
        */
       public String toString() {
           StringBuffer b = new StringBuffer();
  
  
  

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


Mime
View raw message