View Javadoc

    1   /*
    2    $Id: NodePrinter.java 2355 2005-06-18 07:49:15Z cstein $
    3
    4    Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
    5
    6    Redistribution and use of this software and associated documentation
    7    ("Software"), with or without modification, are permitted provided
    8    that the following conditions are met:
    9
    10   1. Redistributions of source code must retain copyright
    11      statements and notices.  Redistributions must also contain a
    12      copy of this document.
    13
    14   2. Redistributions in binary form must reproduce the
    15      above copyright notice, this list of conditions and the
    16      following disclaimer in the documentation and/or other
    17      materials provided with the distribution.
    18
    19   3. The name "groovy" must not be used to endorse or promote
    20      products derived from this Software without prior written
    21      permission of The Codehaus.  For written permission,
    22      please contact info@codehaus.org.
    23
    24   4. Products derived from this Software may not be called "groovy"
    25      nor may "groovy" appear in their names without prior written
    26      permission of The Codehaus. "groovy" is a registered
    27      trademark of The Codehaus.
    28
    29   5. Due credit should be given to The Codehaus -
    30      http://groovy.codehaus.org/
    31
    32   THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
    33   ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
    34   NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
    35   FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
    36   THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
    37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
    41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    42   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
    43   OF THE POSSIBILITY OF SUCH DAMAGE.
    44
    45   */
    46  package groovy.util;
    47
    48
    49  import org.codehaus.groovy.runtime.InvokerHelper;
    50
    51  import java.io.OutputStreamWriter;
    52  import java.io.PrintWriter;
    53  import java.util.Iterator;
    54  import java.util.List;
    55  import java.util.Map;
    56
    57  /***
    58   * A helper class for creating nested trees of data
    59   *
    60   * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
    61   * @author Christian Stein
    62   * @version $Revision: 2355 $
    63   */
    64  public class NodePrinter {
    65
    66      protected final IndentPrinter out;
    67
    68      public NodePrinter() {
    69          this(new IndentPrinter(new PrintWriter(new OutputStreamWriter(System.out))));
    70      }
    71
    72      public NodePrinter(PrintWriter out) {
    73          this(new IndentPrinter(out));
    74      }
    75
    76      public NodePrinter(IndentPrinter out) {
    77          if (out == null) {
    78              throw new NullPointerException("IndentPrinter 'out' must not be null!");
    79          }
    80          this.out = out;
    81      }
    82
    83      public void print(Node node) {
    84          out.printIndent();
    85          printName(node);
    86          Map attributes = node.attributes();
    87          boolean hasAttributes = attributes != null && !attributes.isEmpty();
    88          if (hasAttributes) {
    89              printAttributes(attributes);
    90          }
    91          Object value = node.value();
    92          if (value instanceof List) {
    93              if (!hasAttributes) {
    94                  out.print("()");
    95              }
    96              printList((List) value);
    97          }
    98          else {
    99              if (value instanceof String) {
    100                 out.print("('");
    101                 out.print((String) value);
    102                 out.println("')");
    103             }
    104             else {
    105                 out.println("()");
    106             }
    107         }
    108         out.flush();
    109     }
    110
    111     protected void printName(Node node) {
    112         Object name = node.name();
    113         if (name != null) {
    114             out.print(name.toString());
    115         }
    116         else {
    117             out.print("null");
    118         }
    119     }
    120
    121     protected void printList(List list) {
    122         if (list.isEmpty()) {
    123             out.println("");
    124         }
    125         else {
    126             out.println(" {");
    127             out.incrementIndent();
    128             for (Iterator iter = list.iterator(); iter.hasNext();) {
    129                 Object value = iter.next();
    130                 if (value instanceof Node) {
    131                     print((Node) value);
    132                 }
    133                 else {
    134                     out.printIndent();
    135                     out.print("builder.append(");
    136                     out.print(InvokerHelper.toString(value));
    137                     out.println(")");
    138                 }
    139             }
    140             out.decrementIndent();
    141             out.printIndent();
    142             out.println("}");
    143         }
    144     }
    145
    146
    147     protected void printAttributes(Map attributes) {
    148         out.print("(");
    149         boolean first = true;
    150         for (Iterator iter = attributes.entrySet().iterator(); iter.hasNext();) {
    151             Map.Entry entry = (Map.Entry) iter.next();
    152             if (first) {
    153                 first = false;
    154             }
    155             else {
    156                 out.print(", ");
    157             }
    158             out.print(entry.getKey().toString());
    159             out.print(":");
    160             if (entry.getValue() instanceof String) {
    161                 out.print("'" + entry.getValue() + "'");
    162             }
    163             else {
    164                 out.print(InvokerHelper.toString(entry.getValue()));
    165             }
    166         }
    167         out.print(")");
    168     }
    169
    170 }