KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > dom4j > util > UserDataDocumentFactory


1 /*
2  * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
3  *
4  * This software is open source.
5  * See the bottom of this file for the licence.
6  */
7
8 package org.dom4j.util;
9
10 import org.dom4j.Attribute;
11 import org.dom4j.DocumentFactory;
12 import org.dom4j.Element;
13 import org.dom4j.QName;
14
15 /**
16  * <p>
17  * <code>UserDataDocumentFactory</code> is a factory of XML objects which
18  * support the adornment of a user data object on an Element or Attribute
19  * instance such that the methods <code>getData()</code> and
20  * <code>setData()</code> will get and set the values of a user data object.
21  * This can be useful for developers wishing to create XML trees and adorn the
22  * trees with user defined objects.
23  * </p>
24  *
25  * @author <a HREF="mailto:jstrachan@apache.org">James Strachan </a>
26  * @version $Revision: 1.11 $
27  */
28 public class UserDataDocumentFactory extends DocumentFactory {
29     /** The Singleton instance */
30     protected static transient UserDataDocumentFactory singleton
31             = new UserDataDocumentFactory();
32
33     /**
34      * <p>
35      * Access to the singleton instance of this factory.
36      * </p>
37      *
38      * @return the default singleon instance
39      */
40     public static DocumentFactory getInstance() {
41         return singleton;
42     }
43
44     // DocumentFactory methods
45 // -------------------------------------------------------------------------
46 public Element createElement(QName qname) {
47         return new UserDataElement(qname);
48     }
49
50     public Attribute createAttribute(Element owner, QName qname, String JavaDoc value) {
51         return new UserDataAttribute(qname, value);
52     }
53 }
54
55 /*
56  * Redistribution and use of this software and associated documentation
57  * ("Software"), with or without modification, are permitted provided that the
58  * following conditions are met:
59  *
60  * 1. Redistributions of source code must retain copyright statements and
61  * notices. Redistributions must also contain a copy of this document.
62  *
63  * 2. Redistributions in binary form must reproduce the above copyright notice,
64  * this list of conditions and the following disclaimer in the documentation
65  * and/or other materials provided with the distribution.
66  *
67  * 3. The name "DOM4J" must not be used to endorse or promote products derived
68  * from this Software without prior written permission of MetaStuff, Ltd. For
69  * written permission, please contact dom4j-info@metastuff.com.
70  *
71  * 4. Products derived from this Software may not be called "DOM4J" nor may
72  * "DOM4J" appear in their names without prior written permission of MetaStuff,
73  * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
74  *
75  * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
76  *
77  * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
78  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
79  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
80  * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
81  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
82  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
83  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
84  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
85  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
86  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
87  * POSSIBILITY OF SUCH DAMAGE.
88  *
89  * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
90  */
91
Popular Tags