View Javadoc
1 /* 2 * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/xml/XMLTagLibrary.java,v 1.6 2002/05/17 18:04:00 jstrachan Exp $ 3 * $Revision: 1.6 $ 4 * $Date: 2002/05/17 18:04:00 $ 5 * 6 * ==================================================================== 7 * 8 * The Apache Software License, Version 1.1 9 * 10 * Copyright (c) 1999-2002 The Apache Software Foundation. All rights 11 * reserved. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 17 * 1. Redistributions of source code must retain the above copyright 18 * notice, this list of conditions and the following disclaimer. 19 * 20 * 2. Redistributions in binary form must reproduce the above copyright 21 * notice, this list of conditions and the following disclaimer in 22 * the documentation and/or other materials provided with the 23 * distribution. 24 * 25 * 3. The end-user documentation included with the redistribution, if 26 * any, must include the following acknowlegement: 27 * "This product includes software developed by the 28 * Apache Software Foundation (http://www.apache.org/)." 29 * Alternately, this acknowlegement may appear in the software itself, 30 * if and wherever such third-party acknowlegements normally appear. 31 * 32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software 33 * Foundation" must not be used to endorse or promote products derived 34 * from this software without prior written permission. For written 35 * permission, please contact apache@apache.org. 36 * 37 * 5. Products derived from this software may not be called "Apache" 38 * nor may "Apache" appear in their names without prior written 39 * permission of the Apache Group. 40 * 41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 52 * SUCH DAMAGE. 53 * ==================================================================== 54 * 55 * This software consists of voluntary contributions made by many 56 * individuals on behalf of the Apache Software Foundation. For more 57 * information on the Apache Software Foundation, please see 58 * <http://www.apache.org/>;. 59 * 60 * $Id: XMLTagLibrary.java,v 1.6 2002/05/17 18:04:00 jstrachan Exp $ 61 */ 62 package org.apache.commons.jelly.tags.ant; 63 64 import java.io.File; 65 66 import org.apache.commons.beanutils.ConvertUtils; 67 import org.apache.commons.beanutils.Converter; 68 import org.apache.commons.grant.GrantProject; 69 import org.apache.commons.jelly.JellyContext; 70 import org.apache.commons.jelly.Tag; 71 import org.apache.commons.jelly.TagLibrary; 72 import org.apache.commons.jelly.impl.BeanTagScript; 73 import org.apache.commons.jelly.impl.DynaTagScript; 74 import org.apache.commons.jelly.impl.TagFactory; 75 import org.apache.commons.jelly.impl.TagScript; 76 import org.apache.commons.logging.Log; 77 import org.apache.commons.logging.LogFactory; 78 import org.apache.tools.ant.BuildLogger; 79 import org.apache.tools.ant.NoBannerLogger; 80 import org.apache.tools.ant.Project; 81 import org.apache.tools.ant.taskdefs.optional.junit.FormatterElement; 82 import org.apache.tools.ant.types.EnumeratedAttribute; 83 import org.apache.tools.ant.types.Reference; 84 import org.xml.sax.Attributes; 85 86 /*** 87 * A Jelly custom tag library that allows Ant tasks to be called from inside Jelly. 88 * 89 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a> 90 * @author <a href="mailto:bob@eng.werken.com">bob mcwhirter</a> 91 * @version $Revision: 1.6 $ 92 */ 93 public class AntTagLibrary extends TagLibrary { 94 95 /*** The Log to which logging calls will be made. */ 96 private static final Log log = LogFactory.getLog(AntTagLibrary.class); 97 98 public static final String PROJECT_CONTEXT_HANDLE = "org.apache.commons.jelly.ant.Project"; 99 100 static { 101 102 // register standard converters for Ant types 103 104 ConvertUtils.register( 105 new Converter() { 106 public Object convert(Class type, Object value) { 107 if ( value instanceof File ) { 108 return (File) value; 109 } 110 else if ( value != null ) { 111 String text = value.toString(); 112 return new File( text ); 113 } 114 return null; 115 } 116 }, 117 File.class 118 ); 119 120 ConvertUtils.register( 121 new Converter() { 122 public Object convert(Class type, Object value) { 123 if ( value instanceof Reference ) { 124 return (Reference) value; 125 } 126 else if ( value != null ) { 127 String text = value.toString(); 128 return new Reference( text ); 129 } 130 return null; 131 } 132 }, 133 Reference.class 134 ); 135 136 ConvertUtils.register( 137 new Converter() { 138 public Object convert(Class type, Object value) { 139 if ( value instanceof EnumeratedAttribute ) { 140 return (EnumeratedAttribute) value; 141 } 142 else if ( value instanceof String ) { 143 FormatterElement.TypeAttribute attr = new FormatterElement.TypeAttribute(); 144 attr.setValue( (String) value ); 145 return attr; 146 } 147 return null; 148 } 149 150 }, 151 FormatterElement.TypeAttribute.class 152 ); 153 } 154 155 156 /*** 157 * A helper method which will attempt to find a project in the current context 158 * or install one if need be. 159 * 160 * #### this method could move to an AntUtils class. 161 */ 162 public static Project getProject(JellyContext context) { 163 Project project = (Project) context.findVariable( PROJECT_CONTEXT_HANDLE ); 164 if ( project == null ) { 165 project = createProject(context); 166 context.setVariable( PROJECT_CONTEXT_HANDLE , project ); 167 } 168 return project; 169 } 170 171 /*** 172 * Sets the Ant Project to be used for this JellyContext. 173 * 174 * #### this method could move to an AntUtils class. 175 */ 176 public static void setProject(JellyContext context, Project project) { 177 context.setVariable( PROJECT_CONTEXT_HANDLE, project ); 178 } 179 180 /*** 181 * A helper method to create a new project 182 * 183 * #### this method could move to an AntUtils class. 184 */ 185 public static Project createProject(JellyContext context) { 186 GrantProject project = new GrantProject(); 187 project.setPropsHandler(new JellyPropsHandler(context)); 188 189 BuildLogger logger = new NoBannerLogger(); 190 191 logger.setMessageOutputLevel( org.apache.tools.ant.Project.MSG_INFO ); 192 logger.setOutputPrintStream( System.out ); 193 logger.setErrorPrintStream( System.err); 194 195 project.addBuildListener( logger ); 196 197 project.init(); 198 project.getBaseDir(); 199 200 return project; 201 } 202 203 204 /*** Creates a new script to execute the given tag name and attributes */ 205 public TagScript createTagScript(final String name, Attributes attributes) throws Exception { 206 207 TagScript answer = createCustomTagScript(name, attributes); 208 if ( answer == null ) { 209 answer = new DynaTagScript( 210 new TagFactory() { 211 public Tag createTag() throws Exception { 212 return AntTagLibrary.this.createTag(name); 213 } 214 } 215 ); 216 } 217 return answer; 218 } 219 220 /*** 221 * @return a new TagScript for any custom, statically defined tags, like 'fileScanner' 222 */ 223 public TagScript createCustomTagScript(final String name, Attributes attributes) throws Exception { 224 // custom Ant tags 225 if ( name.equals("fileScanner") ) { 226 return new BeanTagScript( 227 new TagFactory() { 228 public Tag createTag() throws Exception { 229 return new FileScannerTag(new FileScanner()); 230 } 231 } 232 ); 233 } 234 return null; 235 } 236 237 /*** 238 * A helper method which creates an AntTag instance for the given element name 239 */ 240 public Tag createTag(String name) throws Exception { 241 AntTag tag = new AntTag( name ); 242 if ( name.equals( "echo" ) ) { 243 tag.setTrim(false); 244 } 245 return tag; 246 } 247 248 249 }

This page was automatically generated by Maven