org.dom4j.Attribute Maven / Gradle / Ivy
/*
* Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
*
* This software is open source.
* See the bottom of this file for the licence.
*/
package org.dom4j;
/**
* Attribute defines an XML attribute. An attribute may have a
* name, an optional namespace and a value.
*
* @author James Strachan
* @version $Revision: 1.9 $
*/
public interface Attribute extends Node {
/**
* Returns the QName of this attribute which represents the
* local name, the qualified name and the Namespace.
*
* @return the QName associated with this attribute
*/
QName getQName();
/**
* Returns the Namespace of this element if one exists
* otherwise null is returned returned.
*
* @return the Namespace associated with this node
*/
Namespace getNamespace();
/**
* Sets the Namespace of this element or if this element is
* read only then an UnsupportedOperationException is thrown.
*
* @param namespace is the Namespace to associate with this element
*/
void setNamespace(Namespace namespace);
/**
* Returns the namespace prefix of this element if one exists otherwise an
* empty String is returned.
*
* @return the prefix of the Namespace of this element or an
* empty String
*/
String getNamespacePrefix();
/**
* Returns the URI mapped to the namespace of this element if one exists
* otherwise an empty String is returned.
*
* @return the URI for the Namespace of this element or an
* empty String
*/
String getNamespaceURI();
/**
* Returns the fully qualified name of this element.
*
* This will be the same as the value returned from {@link Node#getName()}
* if this element has no namespace attached to this element or an
* expression of the form
*
* getNamespacePrefix() + ":" + getName()
*
* will be returned.
*
* @return the fully qualified name of the element
*/
String getQualifiedName();
/**
* Returns the value of the attribute. This method returns the same value as
* the {@link Node#getText()}method.
*
* @return the value of the attribute
*/
String getValue();
/**
* Sets the value of this attribute or this method will throw an
* UnsupportedOperationException if it is read-only.
*
* @param value is the new value of this attribute
*/
void setValue(String value);
/**
* Accesses the data of this attribute which may implement data typing
* bindings such as XML Schema or Java Bean
* bindings or will return the same value as {@link Node#getText()}.
*
* @return the attribute data
*/
Object getData();
/**
* Sets the data value of this attribute if this element supports data
* binding or calls {@link Node#setText(String)}if it doesn't.
*
* @param data the attribute data
*/
void setData(Object data);
}
/*
* Redistribution and use of this software and associated documentation
* ("Software"), with or without modification, are permitted provided that the
* following conditions are met:
*
* 1. Redistributions of source code must retain copyright statements and
* notices. Redistributions must also contain a copy of this document.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The name "DOM4J" must not be used to endorse or promote products derived
* from this Software without prior written permission of MetaStuff, Ltd. For
* written permission, please contact [email protected].
*
* 4. Products derived from this Software may not be called "DOM4J" nor may
* "DOM4J" appear in their names without prior written permission of MetaStuff,
* Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
*
* 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
*
* THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
*/