View Javadoc

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