001    package biweekly.property;
002    
003    import org.w3c.dom.Document;
004    import org.w3c.dom.Element;
005    import org.w3c.dom.Node;
006    import org.xml.sax.SAXException;
007    
008    import biweekly.util.XmlUtils;
009    
010    /*
011     Copyright (c) 2013, Michael Angstadt
012     All rights reserved.
013    
014     Redistribution and use in source and binary forms, with or without
015     modification, are permitted provided that the following conditions are met: 
016    
017     1. Redistributions of source code must retain the above copyright notice, this
018     list of conditions and the following disclaimer. 
019     2. Redistributions in binary form must reproduce the above copyright notice,
020     this list of conditions and the following disclaimer in the documentation
021     and/or other materials provided with the distribution. 
022    
023     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
024     ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
025     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
026     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
027     ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
028     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
029     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
030     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
031     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
032     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
033     */
034    
035    /**
036     * <p>
037     * Used for storing properties parsed from xCal documents whose XML namespaces
038     * are not part of the xCal XML namespace.
039     * </p>
040     * <p>
041     * <b>Examples:</b>
042     * 
043     * <pre class="brush:java">
044     * //creating a new property
045     * Xml xml = new Xml(&quot;&lt;company xmlns=\&quot;http://example.com\&quot;&gt;&lt;ceo&gt;John Doe&lt;/ceo&gt;&lt;name&gt;Acme Co&lt;/name&gt;&lt;/company&gt;&quot;);
046     * 
047     * //getting the parsed DOM
048     * org.w3c.dom.Document document = xml.getValue();
049     * </pre>
050     * 
051     * </p>
052     * @author Michael Angstadt
053     * @rfc 6321 p.17-8
054     */
055    public class Xml extends ValuedProperty<Document> {
056            /**
057             * Creates an XML property.
058             * @param xml the XML to use as the property's value
059             * @throws SAXException if the XML cannot be parsed
060             */
061            public Xml(String xml) throws SAXException {
062                    super(XmlUtils.toDocument(xml));
063            }
064    
065            /**
066             * Creates an XML property.
067             * @param element the XML element to use as the property's value (the
068             * element is imported into an empty {@link Document} object)
069             */
070            public Xml(Element element) {
071                    super(XmlUtils.createDocument());
072                    Node imported = value.importNode(element, true);
073                    value.appendChild(imported);
074            }
075    
076            /**
077             * Creates an XML property.
078             * @param document the XML document to use as the property's value
079             */
080            public Xml(Document document) {
081                    super(document);
082            }
083    }