commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jstrac...@apache.org
Subject cvs commit: jakarta-commons-sandbox/jelly/src/test/org/apache/commons/jelly/xml suite.jelly
Date Fri, 13 Dec 2002 18:08:31 GMT
jstrachan    2002/12/13 10:08:31

  Modified:    jelly/src/java/org/apache/commons/jelly/tags/xml
                        XMLTagLibrary.java
               jelly/src/test/org/apache/commons/jelly/xml suite.jelly
  Added:       jelly/src/java/org/apache/commons/jelly/tags/xml
                        CommentTag.java
  Log:
  I've added a new <x:comment> tag to output a comment to the underlying XML event stream.

  
  So it can be used inside any Jelly script via either
  
      <x:comment>this is a comment</x:comment>
  
  or
  
      <x:comment text="this is a comment"/>
  
  
  I've added JellyUnit test cases to ensure this works (see the end of the file)
  
  http://cvs.apache.org/viewcvs/jakarta-commons-sandbox/jelly/src/test/org/apache/commons/jelly/xml/suite.jelly?rev=HEAD
  
  
  Revision  Changes    Path
  1.18      +6 -5      jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/xml/XMLTagLibrary.java
  
  Index: XMLTagLibrary.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/xml/XMLTagLibrary.java,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- XMLTagLibrary.java	27 Nov 2002 17:21:16 -0000	1.17
  +++ XMLTagLibrary.java	13 Dec 2002 18:08:31 -0000	1.18
  @@ -99,6 +99,7 @@
           registerTag("attribute", AttributeTag.class);
           registerTag("copy", CopyTag.class);
           registerTag("copyOf", CopyOfTag.class);
  +        registerTag("comment", CommentTag.class);
           registerTag("doctype", DoctypeTag.class);
           registerTag("sort", SortTag.class);
       }
  
  
  
  1.1                  jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/xml/CommentTag.java
  
  Index: CommentTag.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons-sandbox/jelly/src/java/org/apache/commons/jelly/tags/xml/CommentTag.java,v
1.8 2002/05/20 10:09:28 jstrachan Exp $
   * $Revision: 1.8 $
   * $Date: 2002/05/20 10:09:28 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   * 
   * $Id: CommentTag.java,v 1.8 2002/05/20 10:09:28 jstrachan Exp $
   */
  package org.apache.commons.jelly.tags.xml;
  
  import org.apache.commons.jelly.XMLOutput;
  
  
  /** 
   * A tag which outputs a comment to the underlying XMLOutput based on the
   * contents of its body.
   *
   * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
   * @version $Revision: 1.8 $
   */
  public class CommentTag extends XPathTagSupport {
  
      private String text;
      
      public CommentTag() {
      }
  
      // Tag interface
      //------------------------------------------------------------------------- 
      public void doTag(XMLOutput output) throws Exception {
          String text = getText();
          if (text == null) {
              text = getBodyText(false);
          }
          char[] ch = text.toCharArray();
          output.comment(ch, 0, ch.length);
      }
  
      // Properties
      //-------------------------------------------------------------------------        
       
      /**
       * Returns the text.
       * @return String
       */
      public String getText() {
          return text;
      }
  
      /**
       * Sets the comment text. If no text is specified then the body of the tag
       * is used instead.
       * 
       * @param text The comment text to use
       */
      public void setText(String text) {
          this.text = text;
      }
  
  }
  
  
  1.6       +37 -0     jakarta-commons-sandbox/jelly/src/test/org/apache/commons/jelly/xml/suite.jelly
  
  Index: suite.jelly
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/jelly/src/test/org/apache/commons/jelly/xml/suite.jelly,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- suite.jelly	27 Nov 2002 19:22:42 -0000	1.5
  +++ suite.jelly	13 Dec 2002 18:08:31 -0000	1.6
  @@ -174,4 +174,41 @@
   
       </test:case>
   
  +
  +  <test:case name="testComment">
  +  	
  +  	<x:parse var="doc">
  +  		<foo>
  +				<!-- this will not be output -->
  +				
  +				<x:comment text="this is a comment"/>
  +  		</foo>
  +  	</x:parse>
  +	
  +		<test:assert xpath="$doc/foo"/>
  +
  +		<j:set var="t"><x:copyOf select="$doc/foo/comment()"/></j:set>
  +		
  +		<test:assertEquals expected="&lt;!--this is a comment--&gt;" actual="${t.trim()}"/>
  +
  +	</test:case>
  +
  +  <test:case name="testCommentWithTextAttribute">
  +  	
  +  	<x:parse var="doc">
  +  		<foo>
  +				<!-- this will not be output -->
  +				
  +				<x:comment text="this is a comment"/>
  +  		</foo>
  +  	</x:parse>
  +	
  +		<test:assert xpath="$doc/foo"/>
  +
  +		<j:set var="t"><x:copyOf select="$doc/foo/comment()"/></j:set>
  +		
  +		<test:assertEquals expected="&lt;!--this is a comment--&gt;" actual="${t.trim()}"/>
  +  </test:case>
  +  
  +
   </test:suite>
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message