Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | * or more contributor license agreements. See the NOTICE file |
| 4 | * distributed with this work for additional information |
| 5 | * regarding copyright ownership. The ASF licenses this file |
| 6 | * to you under the Apache License, Version 2.0 (the |
| 7 | * "License"); you may not use this file except in compliance |
| 8 | * with the License. You may obtain a copy of the License at |
| 9 | * |
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, |
| 13 | * software distributed under the License is distributed on an |
| 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | * KIND, either express or implied. See the License for the |
| 16 | * specific language governing permissions and limitations |
| 17 | * under the License. |
| 18 | */ |
| 19 | package org.apache.felix.scrplugin.xml; |
| 20 | |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 21 | import java.io.File; |
Carsten Ziegeler | 87a8248 | 2013-01-23 12:19:18 +0000 | [diff] [blame] | 22 | import java.io.FileOutputStream; |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 23 | import java.io.IOException; |
| 24 | import java.io.InputStream; |
Carsten Ziegeler | 87a8248 | 2013-01-23 12:19:18 +0000 | [diff] [blame] | 25 | import java.io.OutputStreamWriter; |
Carsten Ziegeler | 87a8248 | 2013-01-23 12:19:18 +0000 | [diff] [blame] | 26 | import java.io.Writer; |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 27 | import java.util.Properties; |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 28 | |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 29 | import javax.xml.transform.OutputKeys; |
| 30 | import javax.xml.transform.Transformer; |
| 31 | import javax.xml.transform.TransformerException; |
| 32 | import javax.xml.transform.TransformerFactory; |
| 33 | import javax.xml.transform.sax.SAXResult; |
| 34 | import javax.xml.transform.sax.SAXTransformerFactory; |
| 35 | import javax.xml.transform.sax.TransformerHandler; |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 36 | import javax.xml.transform.stream.StreamResult; |
| 37 | import javax.xml.transform.stream.StreamSource; |
| 38 | |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 39 | import org.xml.sax.ContentHandler; |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 40 | import org.xml.sax.SAXException; |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 41 | import org.xml.sax.helpers.AttributesImpl; |
| 42 | |
| 43 | /** |
| 44 | * Utility class for xml/sax handling. |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 45 | */ |
| 46 | public class IOUtils { |
| 47 | |
| 48 | /** The transformer factory. */ |
| 49 | private static final SAXTransformerFactory FACTORY = (SAXTransformerFactory) TransformerFactory.newInstance(); |
| 50 | |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 51 | /** |
| 52 | * Parse a file and send the sax events to the content handler. |
| 53 | * @param file |
| 54 | * @param handler |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 55 | * @throws TransformerException |
| 56 | */ |
Carsten Ziegeler | b1a850f | 2013-01-23 12:55:54 +0000 | [diff] [blame] | 57 | public static final void parse(final InputStream file, final ContentHandler handler) |
Felix Meschberger | 1fd5829 | 2009-10-02 12:59:27 +0000 | [diff] [blame] | 58 | throws TransformerException { |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 59 | final Transformer transformer = FACTORY.newTransformer(); |
Felix Meschberger | 1fd5829 | 2009-10-02 12:59:27 +0000 | [diff] [blame] | 60 | transformer.transform( new StreamSource( file ), new SAXResult( handler ) ); |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 61 | } |
| 62 | |
Carsten Ziegeler | b1a850f | 2013-01-23 12:55:54 +0000 | [diff] [blame] | 63 | /** |
| 64 | * Get a serializer to write XML to a file. |
| 65 | */ |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 66 | public static ContentHandler getSerializer(final File file) |
Carsten Ziegeler | a21b584 | 2013-01-23 13:00:46 +0000 | [diff] [blame] | 67 | throws TransformerException, IOException { |
| 68 | final Writer writer = new OutputStreamWriter(new FileOutputStream(file), "UTF-8"); |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 69 | |
Carsten Ziegeler | a21b584 | 2013-01-23 13:00:46 +0000 | [diff] [blame] | 70 | final TransformerHandler transformerHandler = FACTORY.newTransformerHandler(); |
| 71 | final Transformer transformer = transformerHandler.getTransformer(); |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 72 | |
Carsten Ziegeler | a21b584 | 2013-01-23 13:00:46 +0000 | [diff] [blame] | 73 | final Properties format = new Properties(); |
| 74 | format.put(OutputKeys.METHOD, "xml"); |
| 75 | format.put(OutputKeys.OMIT_XML_DECLARATION, "no"); |
| 76 | format.put(OutputKeys.ENCODING, "UTF-8"); |
| 77 | format.put(OutputKeys.INDENT, "yes"); |
Carsten Ziegeler | b1a850f | 2013-01-23 12:55:54 +0000 | [diff] [blame] | 78 | |
Carsten Ziegeler | a21b584 | 2013-01-23 13:00:46 +0000 | [diff] [blame] | 79 | transformer.setOutputProperties(format); |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 80 | |
Carsten Ziegeler | a21b584 | 2013-01-23 13:00:46 +0000 | [diff] [blame] | 81 | transformerHandler.setResult(new StreamResult(writer)); |
Carsten Ziegeler | 59c95d5 | 2012-08-31 07:00:42 +0000 | [diff] [blame] | 82 | |
Carsten Ziegeler | a21b584 | 2013-01-23 13:00:46 +0000 | [diff] [blame] | 83 | return transformerHandler; |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 84 | } |
| 85 | |
Carsten Ziegeler | 28ff270 | 2007-08-28 15:40:03 +0000 | [diff] [blame] | 86 | /** |
| 87 | * Helper method to add an attribute. |
| 88 | * This implementation adds a new attribute with the given name |
| 89 | * and value. Before adding the value is checked for non-null. |
| 90 | * @param ai The attributes impl receiving the additional attribute. |
| 91 | * @param name The name of the attribute. |
| 92 | * @param value The value of the attribute. |
| 93 | */ |
Carsten Ziegeler | b1a850f | 2013-01-23 12:55:54 +0000 | [diff] [blame] | 94 | public static void addAttribute(final AttributesImpl ai, final String name, final Object value) { |
Carsten Ziegeler | 28ff270 | 2007-08-28 15:40:03 +0000 | [diff] [blame] | 95 | if ( value != null ) { |
| 96 | ai.addAttribute("", name, name, "CDATA", value.toString()); |
| 97 | } |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * Helper method writing out a string. |
Carsten Ziegeler | 1d4f1e5 | 2008-06-03 07:47:40 +0000 | [diff] [blame] | 102 | * @param ch The content handler. |
Carsten Ziegeler | 28ff270 | 2007-08-28 15:40:03 +0000 | [diff] [blame] | 103 | * @param text |
| 104 | * @throws SAXException |
| 105 | */ |
Carsten Ziegeler | b1a850f | 2013-01-23 12:55:54 +0000 | [diff] [blame] | 106 | public static void text(final ContentHandler ch, final String text) |
Carsten Ziegeler | 28ff270 | 2007-08-28 15:40:03 +0000 | [diff] [blame] | 107 | throws SAXException { |
| 108 | if ( text != null ) { |
| 109 | final char[] c = text.toCharArray(); |
| 110 | ch.characters(c, 0, c.length); |
| 111 | } |
| 112 | } |
Carsten Ziegeler | 1d4f1e5 | 2008-06-03 07:47:40 +0000 | [diff] [blame] | 113 | |
| 114 | /** |
| 115 | * Helper method to indent the xml elements. |
| 116 | * Each level is indented with four spaces. |
| 117 | * @param ch The content handler. |
| 118 | * @param level The level of indention. |
| 119 | */ |
Carsten Ziegeler | b1a850f | 2013-01-23 12:55:54 +0000 | [diff] [blame] | 120 | public static void indent(final ContentHandler ch, final int level) |
Carsten Ziegeler | 1d4f1e5 | 2008-06-03 07:47:40 +0000 | [diff] [blame] | 121 | throws SAXException { |
| 122 | for(int i=0;i<level;i++) { |
| 123 | IOUtils.text(ch, " "); |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | /** |
| 128 | * Helper method to create a new line. |
| 129 | * @param ch The content handler. |
| 130 | * @throws SAXException |
| 131 | */ |
Carsten Ziegeler | b1a850f | 2013-01-23 12:55:54 +0000 | [diff] [blame] | 132 | public static void newline(final ContentHandler ch) |
Carsten Ziegeler | 1d4f1e5 | 2008-06-03 07:47:40 +0000 | [diff] [blame] | 133 | throws SAXException { |
| 134 | IOUtils.text(ch, "\n"); |
| 135 | } |
Carsten Ziegeler | 1da0359 | 2007-08-24 07:27:04 +0000 | [diff] [blame] | 136 | } |