UserDataAttribute xref

View Javadoc

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