null.
+ * @param value The new value of the property.
+ * Must not be null.
+ * @return true if this helper has stored the property, false if it
+ * couldn't. Each helper should delegate to the next one ( unless it
+ * has a good reason not to ).
+ */
+ public boolean setPropertyHook(String ns, String name,
+ Object value,
+ boolean inherited, boolean user,
+ boolean isNew)
+ {
+ if( getNext()!=null ) {
+ boolean subst=getNext().setPropertyHook(ns, name, value,
+ inherited, user, isNew);
+ // If next has handled the property
+ if( subst ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+ /** Get a property. If all hooks return null, the default
+ * tables will be used.
+ *
+ * @param ns
+ * @param name
+ * @return
+ */
+ public Object getPropertyHook(String ns, String name, boolean user) {
+ if( getNext() != null ) {
+ Object o=getNext().getPropertyHook(ns, name, user);
+ if( o!= null ) return o;
+ }
+ // Experimental/Testing, will be removed
+ if( name.startsWith( "toString:" )) {
+ name=name.substring( "toString:".length());
+ Object v=project.getReference( name );
+ if( v==null ) return null;
+ return v.toString();
+ }
+
+
+ return null;
+ }
+
+ // -------------------- Optional methods --------------------
+ // You can override those methods if you want to optimize or
+ // do advanced things ( like support a special syntax ).
+ // The methods do not chain - you should use them when embedding ant
+ // ( by replacing the main helper )
+
+ /**
+ * Parses a string containing ${xxx} style property
+ * references into two lists. The first list is a collection
+ * of text fragments, while the other is a set of string property names.
+ * null entries in the first list indicate a property
+ * reference from the second list.
+ *
+ * It can be overriden with a more efficient or customized version.
+ *
+ * @param value Text to parse. Must not be null.
+ * @param fragments List to add text fragments to.
+ * Must not be null.
+ * @param propertyRefs List to add property names to.
+ * Must not be null.
+ *
+ * @exception BuildException if the string contains an opening
+ * ${ without a closing
+ * }
+ */
+ public void parsePropertyString(String value, Vector fragments,
+ Vector propertyRefs)
+ throws BuildException
+ {
+ parsePropertyStringDefault(value, fragments, propertyRefs);
+ }
+
+ /**
+ * Replaces ${xxx} style constructions in the given value
+ * with the string value of the corresponding data types.
+ *
+ * @param value The string to be scanned for property references.
+ * May be null, in which case this
+ * method returns immediately with no effect.
+ * @param keys Mapping (String to String) of property names to their
+ * values. If null, only project properties will
+ * be used.
+ *
+ * @exception BuildException if the string contains an opening
+ * ${ without a closing
+ * }
+ * @return the original string with the properties replaced, or
+ * null if the original string is null.
+ */
+ public String replaceProperties(String ns, String value,
+ Hashtable keys)
+ throws BuildException
+ {
+ if (value == null) {
+ return null;
+ }
+
+ Vector fragments = new Vector();
+ Vector propertyRefs = new Vector();
+ parsePropertyString(value, fragments, propertyRefs);
+
+ StringBuffer sb = new StringBuffer();
+ Enumeration i = fragments.elements();
+ Enumeration j = propertyRefs.elements();
+
+ while (i.hasMoreElements()) {
+ String fragment = (String) i.nextElement();
+ if (fragment == null) {
+ String propertyName = (String) j.nextElement();
+ Object replacement=null;
+
+ // try to get it from the project or keys
+ // Backward compatibility
+ if( keys!=null ) {
+ replacement=keys.get(propertyName);
+ }
+ if( replacement==null ) {
+ replacement=getProperty(ns, propertyName);
+ }
+
+ if (replacement == null ) {
+ project.log("Property ${" + propertyName
+ + "} has not been set", Project.MSG_VERBOSE);
+ }
+ fragment = (replacement!=null)
+ ? replacement.toString()
+ : "${" + propertyName + "}";
+ }
+ sb.append(fragment);
+ }
+
+ return sb.toString();
+ }
+
+ // -------------------- Default implementation --------------------
+ // Methods used to support the default behavior and provide backward
+ // compatibility. Some will be deprecated, you should avoid calling them.
+
+
+ /** Default implementation of setProperty. Will be called from Project.
+ * This is the original 1.5 implementation, with calls to the hook
+ * added.
+ */
+ public synchronized boolean setProperty(String ns, String name,
+ Object value, boolean verbose)
+ {
+ // user ( CLI ) properties take precedence
+ if (null != userProperties.get(name)) {
+ if( verbose ) {
+ project.log("Override ignored for user property " + name,
+ Project.MSG_VERBOSE);
+ }
+ return false;
+ }
+
+ boolean done=this.setPropertyHook(ns, name, value, false, false, false);
+ if( done ) {
+ return true;
+ }
+
+ if (null != properties.get(name) && verbose) {
+ project.log("Overriding previous definition of property " + name,
+ Project.MSG_VERBOSE);
+ }
+
+ if( verbose ) {
+ project.log("Setting project property: " + name + " -> " +
+ value, Project.MSG_DEBUG);
+ }
+ properties.put(name, value);
+ return true;
+ }
+
+ /**
+ * Sets a property if no value currently exists. If the property
+ * exists already, a message is logged and the method returns with
+ * no other effect.
+ *
+ * @param name The name of property to set.
+ * Must not be null.
+ * @param value The new value of the property.
+ * Must not be null.
+ * @since Ant 1.6
+ */
+ public synchronized void setNewProperty(String ns, String name,
+ Object value)
+ {
+ if (null != properties.get(name)) {
+ project.log("Override ignored for property " + name,
+ Project.MSG_VERBOSE);
+ return;
+ }
+
+ boolean done=this.setPropertyHook(ns, name, value, false, true, false);
+ if( done ) {
+ return;
+ }
+
+ project.log("Setting project property: " + name + " -> " +
+ value, Project.MSG_DEBUG);
+ properties.put(name, value);
+ }
+
+ /**
+ * Sets a user property, which cannot be overwritten by
+ * set/unset property calls. Any previous value is overwritten.
+ * @param name The name of property to set.
+ * Must not be null.
+ * @param value The new value of the property.
+ * Must not be null.
+ */
+ public synchronized void setUserProperty(String ns, String name,
+ Object value)
+ {
+ project.log("Setting ro project property: " + name + " -> " +
+ value, Project.MSG_DEBUG);
+ userProperties.put(name, value);
+
+ boolean done=this.setPropertyHook(ns, name, value, false, false, true);
+ if( done ) {
+ return;
+ }
+ properties.put(name, value);
+ }
+
+ /**
+ * Sets a user property, which cannot be overwritten by set/unset
+ * property calls. Any previous value is overwritten. Also marks
+ * these properties as properties that have not come from the
+ * command line.
+ *
+ * @param name The name of property to set.
+ * Must not be null.
+ * @param value The new value of the property.
+ * Must not be null.
+ */
+ public synchronized void setInheritedProperty(String ns, String name,
+ Object value)
+ {
+ inheritedProperties.put(name, value);
+
+ project.log("Setting ro project property: " + name + " -> " +
+ value, Project.MSG_DEBUG);
+ userProperties.put(name, value);
+
+ boolean done=this.setPropertyHook(ns, name, value, true, false, false);
+ if( done ) {
+ return;
+ }
+ properties.put(name, value);
+ }
+
+ // -------------------- Getting properties --------------------
+
+ /**
+ * Returns the value of a property, if it is set. You can override
+ * this method in order to plug your own storage.
+ *
+ * @param name The name of the property.
+ * May be null, in which case
+ * the return value is also null.
+ * @return the property value, or null for no match
+ * or if a null name is provided.
+ */
+ public Object getProperty(String ns, String name) {
+ if (name == null) {
+ return null;
+ }
+
+ Object o=getPropertyHook(ns, name, false);
+ if( o!= null ) {
+ return o;
+ }
+
+ return properties.get(name);
+ }
+ /**
+ * Returns the value of a user property, if it is set.
+ *
+ * @param name The name of the property.
+ * May be null, in which case
+ * the return value is also null.
+ * @return the property value, or null for no match
+ * or if a null name is provided.
+ */
+ public Object getUserProperty(String ns, String name) {
+ if (name == null) {
+ return null;
+ }
+ Object o=getPropertyHook(ns, name, true);
+ if( o!= null ) {
+ return o;
+ }
+ return userProperties.get(name);
+ }
+
+
+ // -------------------- Access to property tables --------------------
+ // This is used to support ant call and similar tasks. It should be
+ // deprecated, it is possible to use a better ( more efficient )
+ // mechanism to preserve the context.
+
+ // TODO: do we need to delegate ?
+
+ /**
+ * Returns a copy of the properties table.
+ * @return a hashtable containing all properties
+ * (including user properties).
+ */
+ public Hashtable getProperties() {
+ Hashtable propertiesCopy = new Hashtable();
+
+ Enumeration e = properties.keys();
+ while (e.hasMoreElements()) {
+ Object name = e.nextElement();
+ Object value = properties.get(name);
+ propertiesCopy.put(name, value);
+ }
+
+ // There is a better way to save the context. This shouldn't
+ // delegate to next, it's for backward compat only.
+
+ return propertiesCopy;
+ }
+
+ /**
+ * Returns a copy of the user property hashtable
+ * @return a hashtable containing just the user properties
+ */
+ public Hashtable getUserProperties() {
+ Hashtable propertiesCopy = new Hashtable();
+
+ Enumeration e = userProperties.keys();
+ while (e.hasMoreElements()) {
+ Object name = e.nextElement();
+ Object value = properties.get(name);
+ propertiesCopy.put(name, value);
+ }
+
+ return propertiesCopy;
+ }
+
+ /**
+ * Copies all user properties that have not been set on the
+ * command line or a GUI tool from this instance to the Project
+ * instance given as the argument.
+ *
+ * To copy all "user" properties, you will also have to call + * {@link #copyUserProperties copyUserProperties}.
+ * + * @param other the project to copy the properties to. Must not be null. + * + * @since Ant 1.6 + */ + public void copyInheritedProperties(Project other) { + Enumeration e = inheritedProperties.keys(); + while (e.hasMoreElements()) { + String arg = e.nextElement().toString(); + if (other.getUserProperty(arg) != null) { + continue; + } + Object value = inheritedProperties.get(arg); + other.setInheritedProperty(arg, value.toString()); + } + } + + /** + * Copies all user properties that have been set on the command + * line or a GUI tool from this instance to the Project instance + * given as the argument. + * + *To copy all "user" properties, you will also have to call + * {@link #copyInheritedProperties copyInheritedProperties}.
+ * + * @param other the project to copy the properties to. Must not be null. + * + * @since Ant 1.6 + */ + public void copyUserProperties(Project other) { + Enumeration e = userProperties.keys(); + while (e.hasMoreElements()) { + Object arg = e.nextElement(); + if (inheritedProperties.containsKey(arg)) { + continue; + } + Object value = userProperties.get(arg); + other.setUserProperty(arg.toString(), value.toString()); + } + } + + // -------------------- Property parsing -------------------- + // Moved from ProjectHelper. You can override the static method - + // this is used for backward compatibility ( for code that calls + // the parse method in ProjectHelper ). + + /** Default parsing method. It is here only to support backward compat + * for the static ProjectHelper.parsePropertyString(). + */ + static void parsePropertyStringDefault(String value, Vector fragments, + Vector propertyRefs) + throws BuildException + { + int prev = 0; + int pos; + //search for the next instance of $ from the 'prev' position + while ((pos = value.indexOf("$", prev)) >= 0) { + + //if there was any text before this, add it as a fragment + //TODO, this check could be modified to go if pos>prev; + //seems like this current version could stick empty strings + //into the list + if (pos > 0) { + fragments.addElement(value.substring(prev, pos)); + } + //if we are at the end of the string, we tack on a $ + //then move past it + if (pos == (value.length() - 1)) { + fragments.addElement("$"); + prev = pos + 1; + } else if (value.charAt(pos + 1) != '{') { + //peek ahead to see if the next char is a property or not + //not a property: insert the char as a literal + /* + fragments.addElement(value.substring(pos + 1, pos + 2)); + prev = pos + 2; + */ + if (value.charAt(pos + 1) == '$') { + //backwards compatibility two $ map to one mode + fragments.addElement("$"); + prev = pos + 2; + } else { + //new behaviour: $X maps to $X for all values of X!='$' + fragments.addElement(value.substring(pos, pos + 2)); + prev = pos + 2; + } + + } else { + //property found, extract its name or bail on a typo + int endName = value.indexOf('}', pos); + if (endName < 0) { + throw new BuildException("Syntax error in property: " + + value); + } + String propertyName = value.substring(pos + 2, endName); + fragments.addElement(null); + propertyRefs.addElement(propertyName); + prev = endName + 1; + } + } + //no more $ signs found + //if there is any tail to the file, append it + if (prev < value.length()) { + fragments.addElement(value.substring(prev)); + } + } + +}