* * Attribute "destfile" defines a file to send the properties to. This can be * processed as a standard property file later.
* * Attribute "prefix" defines a prefix which is used to filter the properties * only those properties starting with this prefix will be echoed.
* * By default, the "failonerror" attribute is enabled. If an error occurs while * writing the properties to a file, and this attribute is enabled, then a * BuildException will be thrown. If disabled, then IO errors will be reported * as a log statement, but no error will be thrown.
* * Examples:
* <echoproperties /> *Report the current properties to the log.
* *
* <echoproperties destfile="my.properties" /> *Report the current properties to the file "my.properties", and will * fail the build if the file could not be created or written to.
* *
* <echoproperties destfile="my.properties" failonerror="false" * prefix="ant" /> *Report all properties beginning with 'ant' to the file * "my.properties", and will log a message if the file could not be created or * written to, but will still allow the build to continue. * *@author Matt Albrecht * groboclown@users.sourceforge.net *@author Ingmar Stein stein@xtramind.com *@since Ant 1.5 */ public class EchoProperties extends Task { /** * the properties element. */ private static final String PROPERTIES = "properties"; /** * the property element. */ private static final String PROPERTY = "property"; /** * name attribute for property, testcase and testsuite elements. */ private static final String ATTR_NAME = "name"; /** * value attribute for property elements. */ private static final String ATTR_VALUE = "value"; /** * the input file. */ private File inFile = null; /** * File object pointing to the output file. If this is null, then we output * to the project log, not to a file. */ private File destfile = null; /** * If this is true, then errors generated during file output will become * build errors, and if false, then such errors will be logged, but not * thrown. */ private boolean failonerror = true; /** * Prefix string controls which properties to save. */ private String prefix = null; private String format = "text"; /** * Sets the input file. * * @param file the input file */ public void setSrcfile( File file ) { inFile = file; } /** * Set a file to store the property output. If this is never specified, * then the output will be sent to the Ant log. * *@param destfile file to store the property output */ public void setDestfile(File destfile) { this.destfile = destfile; } /** * Sets the failure mode for the task. * *@param failonerror true if IO exceptions are reported as build * exceptions, or false if IO exceptions are ignored. */ public void setFailOnError(boolean failonerror) { this.failonerror = failonerror; } /** * If the prefix is set, then only properties which start with this * prefix string will be recorded. If this is never set, or it is set * to an empty string or null, then all properties will be * recorded.
* * For example, if the property is set as: *
<echoproperties prefix="ant." />* then the property "ant.home" will be recorded, but "ant-example" * will not. * *@param prefix The new prefix value */ public void setPrefix(String prefix) { this.prefix = prefix; } public void setFormat(FormatAttribute ea) { format = ea.getValue(); } public static class FormatAttribute extends EnumeratedAttribute { private String [] formats = new String[]{"xml", "text"}; public String[] getValues() { return formats; } } /** * Run the task. * *@exception BuildException trouble, probably file IO */ public void execute() throws BuildException { Properties props = new Properties(); /* load properties from file if specified, otherwise use Ant's properties */ if( inFile == null ) { // add ant properties CollectionUtils.putAll( props, project.getProperties() ); } else { if (inFile.exists() && inFile.isDirectory()) { String message = "srcfile is a directory!"; if (failonerror) { throw new BuildException(message, location); } else { log( message, Project.MSG_ERR ); } return; } if (inFile.exists() && !inFile.canRead()) { String message = "Can not read from the specified srcfile!"; if( failonerror ) { throw new BuildException( message, location ); } else { log( message, Project.MSG_ERR ); } return; } FileInputStream in = null; try { in = new FileInputStream( inFile ); props.load( in ); } catch( FileNotFoundException fnfe ) { String message = "Could not find file " + inFile.getAbsolutePath(); if (failonerror) { throw new BuildException(message, fnfe, location); } else { log( message, Project.MSG_WARN ); } return; } catch( IOException ioe ) { String message = "Could not read file " + inFile.getAbsolutePath(); if (failonerror) { throw new BuildException(message, ioe, location); } else { log( message, Project.MSG_WARN ); } return; } finally { try { if( null != in ) { in.close(); } } catch(IOException ioe) {} } } if (destfile == null) { ByteArrayOutputStream baos = new ByteArrayOutputStream(); try { saveProperties(props, baos); } catch( IOException ioe ) {} log(baos.toString(), Project.MSG_INFO); } else { if (destfile.exists() && destfile.isDirectory()) { String message = "destfile is a directory!"; if (failonerror) { throw new BuildException(message, location); } else { log( message, Project.MSG_ERR ); } return; } if (destfile.exists() && !destfile.canWrite()) { String message = "Can not write to the specified destfile!"; if( failonerror ) { throw new BuildException( message, location ); } else { log( message, Project.MSG_ERR ); } return; } try { OutputStream os = new FileOutputStream(destfile); saveProperties(props, os); } catch (IOException ioe) { String message = "Destfile " + destfile + " could not be written to."; if (failonerror) { throw new BuildException(message, ioe, location); } else { log(message, Project.MSG_INFO); } } } } /** * Send the key/value pairs in the hashtable to the given output stream. * Only those properties matching the prefix constraint will be * sent to the output stream. * The output stream will be closed when this method returns. * *@param allProps propfile to save *@param os output stream *@exception IOException trouble */ protected void saveProperties(Properties allProps, OutputStream os) throws IOException, BuildException { Properties props = new Properties(); Enumeration enum = allProps.keys(); while (enum.hasMoreElements()) { String name = (String) enum.nextElement(); String value = (String) allProps.get(name); if (prefix == null || name.indexOf(prefix) == 0) { props.put(name, value); } } try { if ("text".equals(format)) { jdkSaveProperties(props, os, "Ant properties"); } else if ("xml".equals(format)) { xmlSaveProperties(props, os ); } } finally { os.close(); } } protected void xmlSaveProperties(Properties props, OutputStream os) throws IOException { // create XML document Document doc = getDocumentBuilder().newDocument(); Element rootElement = doc.createElement( PROPERTIES ); // output properties String name; Enumeration e = props.propertyNames(); while( e.hasMoreElements() ) { name = (String)e.nextElement(); Element propElement = doc.createElement( PROPERTY ); propElement.setAttribute( ATTR_NAME, name ); propElement.setAttribute( ATTR_VALUE, props.getProperty( name ) ); rootElement.appendChild( propElement ); } Writer wri = null; try { wri = new OutputStreamWriter( os, "UTF8" ); wri.write( "" ); ( new DOMElementWriter() ).write( rootElement, wri, 0, "\t" ); wri.flush(); } catch( IOException ioe ) { throw new BuildException( "Unable to write XML file", ioe ); } finally { if( wri != null ) { wri.close(); } } } /** * JDK 1.2 allows for the safer method * Properties.store( OutputStream, String ), which throws an * IOException on an output error. This method attempts to * use the JDK 1.2 method first, and if that does not exist, then the * JDK 1.0 compatible method * Properties.save( OutputStream, String ) is used instead. * *@param props the properties to record *@param os record the properties to this output stream *@param header prepend this header to the property output *@exception IOException on an I/O error during a write. Only thrown * for JDK 1.2+. */ protected void jdkSaveProperties(Properties props, OutputStream os, String header) throws IOException { try { java.lang.reflect.Method m = props.getClass().getMethod( "store", new Class[]{OutputStream.class, String.class}); m.invoke(props, new Object[]{os, header}); } catch (java.lang.reflect.InvocationTargetException ite) { Throwable t = ite.getTargetException(); if (t instanceof IOException) { throw (IOException) t; } if (t instanceof RuntimeException) { throw (RuntimeException) t; } // not an expected exception. Resort to JDK 1.0 to execute // this method jdk10SaveProperties(props, os, header); } catch (ThreadDeath td) { // don't trap thread death errors. throw td; } catch (Throwable ex) { // this 'store' method is not available, so resort to the JDK 1.0 // compatible method. jdk10SaveProperties(props, os, header); } } /** * Save the properties to the output stream using the JDK 1.0 compatible * method. This won't throw an IOException on an output error. * *@param props the properties to record *@param os record the properties to this output stream *@param header prepend this header to the property output */ protected void jdk10SaveProperties(Properties props, OutputStream os, String header) { props.save(os, header); } /** * Uses the DocumentBuilderFactory to get a DocumentBuilder instance. * * @return The DocumentBuilder instance */ private static DocumentBuilder getDocumentBuilder() { try { return DocumentBuilderFactory.newInstance().newDocumentBuilder(); } catch( Exception e ) { throw new ExceptionInInitializerError( e ); } } }