@@ -68,6 +68,8 @@ import org.apache.tools.ant.Task;
import org.apache.tools.ant.TaskContainer; import org.apache.tools.ant.TaskContainer;
import org.apache.tools.ant.UnknownElement; import org.apache.tools.ant.UnknownElement;
import org.apache.tools.ant.types.EnumeratedAttribute;
/** /**
* Describe class <code>MacroDef</code> here. * Describe class <code>MacroDef</code> here.
* *
@@ -78,9 +80,10 @@ public class MacroDef extends Task implements AntlibInterface, TaskContainer {
private UnknownElement nestedTask; private UnknownElement nestedTask;
private String name; private String name;
private String componentName; private String componentName;
private List param s = new ArrayList();
private List attribute s = new ArrayList();
private Map elements = new HashMap(); private Map elements = new HashMap();
private String uri;
private String uri;
private int attributeStyle = AttributeStyle.ANT;
/** /**
* Name of the definition * Name of the definition
@@ -105,6 +108,46 @@ public class MacroDef extends Task implements AntlibInterface, TaskContainer {
this.uri = uri; this.uri = uri;
} }
/**
* Enumerated type for attributeStyle attribute
*
* @see EnumeratedAttribute
*/
public static class AttributeStyle extends EnumeratedAttribute {
/** Enumerated values */
public static final int ANT = 0, XPATH = 1;
/**
* get the values
* @return an array of the allowed values for this attribute.
*/
public String[] getValues() {
return new String[] {"ant", "xpath"};
}
}
/**
* <em>Expermential</em>
* I am uncertain at the moment how to encode attributes
* using ant style ${attribute} or xpath style @attribute.
* The first may get mixed up with ant properties and
* the second may get mixed up with xpath.
* The default at the moment is ant s
*
* @param style an <code>AttributeStyle</code> value
*/
public void setAttributeStyle(AttributeStyle style) {
attributeStyle = style.getIndex();
}
/**
* <em>Expermential</em>
* @return the attribute style
*/
public int getAttributeStyle() {
return attributeStyle;
}
/** /**
* Set the class loader. * Set the class loader.
* Not used * Not used
@@ -139,10 +182,10 @@ public class MacroDef extends Task implements AntlibInterface, TaskContainer {
} }
/** /**
* @return the nested Param s
* @return the nested Attribute s
*/ */
public List getParam s() {
return param s;
public List getAttribute s() {
return attribute s;
} }
/** /**
@@ -153,16 +196,46 @@ public class MacroDef extends Task implements AntlibInterface, TaskContainer {
} }
/** /**
* Add a param element.
* Check if a character is a valid character for an element or
* attribute name
* @param c the character to check
* @return true if the character is a letter or digit or '.' or '-'
* attribute name
*/
public static boolean isValidNameCharacter(char c) {
// ? is there an xml api for this ?
return Character.isLetterOrDigit(c) || c == '.' || c == '-';
}
/**
* Check if a string is a valid name for an element or
* attribute
* @param name the string to check
* @return true if the name consists of valid name characters
*/
private static boolean isValidName(String name) {
if (name.length() == 0) {
return false;
}
for (int i = 0; i < name.length(); ++i) {
if (!isValidNameCharacter(name.charAt(i))) {
return false;
}
}
return true;
}
/**
* Add an attribute element.
* *
* @param param a param nested element.
* @param attribute an attribute nested element.
*/ */
public void addConfiguredParam(Param param) {
if (param.getName() == null) {
public void addConfiguredAttribute(Attribute attribute ) {
if (attribute .getName() == null) {
throw new BuildException( throw new BuildException(
"the param nested element needed a \"name\" attribute");
"the attribute nested element needed a \"name\" attribute");
} }
params.add(param);
attributes.add(attribute );
} }
/** /**
@@ -207,20 +280,24 @@ public class MacroDef extends Task implements AntlibInterface, TaskContainer {
* A nested element for the MacroDef task. * A nested element for the MacroDef task.
* *
*/ */
public static class Param {
public static class Attribute {
private String name; private String name;
private String defaultValue; private String defaultValue;
/** /**
* The name of the parameter .
* The name of the attribute .
* *
* @param name the name of the parameter
* @param name the name of the attribute
*/ */
public void setName(String name) { public void setName(String name) {
if (!isValidName(name)) {
throw new BuildException(
"Illegal name [" + name + "] for attribute");
}
this.name = name; this.name = name;
} }
/** /**
* @return the name of the parameter.
* @return the name of the attribute
*/ */
public String getName() { public String getName() {
return name; return name;
@@ -257,6 +334,10 @@ public class MacroDef extends Task implements AntlibInterface, TaskContainer {
* @param name the name of the element. * @param name the name of the element.
*/ */
public void setName(String name) { public void setName(String name) {
if (!isValidName(name)) {
throw new BuildException(
"Illegal name [" + name + "] for attribute");
}
this.name = name; this.name = name;
} }
@@ -316,5 +397,17 @@ public class MacroDef extends Task implements AntlibInterface, TaskContainer {
((MacroInstance) o).setTemplate(template); ((MacroInstance) o).setTemplate(template);
return o; return o;
} }
/**
* Equality method for this definition
* This only checks for pointer equality.
*
* @param other another definition
* @param project the current project
* @return true if the definitions are the same
*/
public boolean sameDefinition(AntTypeDefinition other, Project project) {
return this == other;
}
} }
} }
Peter Reilly