org.sapia.util.xml.Attribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sapia_utils Show documentation
The newest version!
package org.sapia.util.xml;


// Import of Sun's JDK classes
// ---------------------------
import java.io.Serializable;


/**
 * The Attribute class is a simple object representation of an XML attribute.
 * It contains three attributes: a name, a value and a namespace prefix.
 *
 * @author Jean-Cedric Desrochers
 * 
 * Copyright:
Copyright © 2002-2003 Sapia Open Source Software. All Rights Reserved.
 * License:
Read the license.txt file of the jar or visit the
 *        license page at the Sapia OSS web site
 * 
 */
public class Attribute implements Serializable {
  /////////////////////////////////////////////////////////////////////////////////////////
  /////////////////////////////////  INSTANCE ATTRIBUTES  /////////////////////////////////
  /////////////////////////////////////////////////////////////////////////////////////////

  /** The namespace prefix of this attribute. */
  private String _theNamespacePrefix;

  /** The name of this attribute. */
  private String _theName;

  /** The value of this attribute. */
  private String _theValue;

  /////////////////////////////////////////////////////////////////////////////////////////
  ////////////////////////////////////  CONSTRUCTORS  /////////////////////////////////////
  /////////////////////////////////////////////////////////////////////////////////////////

  /**
   * Creates a new Attribute instance.
   */
  public Attribute() {
  }

  /**
   * Creates a new Attribute instance.
   */
  public Attribute(String aName, String aValue) {
    _theName    = aName;
    _theValue   = aValue;
  }

  /**
   * Creates a new Attribute instance.
   */
  public Attribute(String aNamespacePrefix, String aName, String aValue) {
    _theNamespacePrefix   = aNamespacePrefix;
    _theName              = aName;
    _theValue             = aValue;
  }

  /////////////////////////////////////////////////////////////////////////////////////////
  //////////////////////////////////  ACCESSOR METHODS  ///////////////////////////////////
  /////////////////////////////////////////////////////////////////////////////////////////

  /**
   * Returns the namespace prefix of this attribute.
   *
   * @return The namespace prefix of this attribute.
   */
  public String getNamespacePrefix() {
    return _theNamespacePrefix;
  }

  /**
   * Returns the name of this attribute.
   *
   * @return The name of this attribute.
   */
  public String getName() {
    return _theName;
  }

  /**
   * Returns the value of this attribute.
   *
   * @return The value of this attribute.
   */
  public String getValue() {
    return _theValue;
  }

  /////////////////////////////////////////////////////////////////////////////////////////
  ///////////////////////////////////  MUTATOR METHODS  ///////////////////////////////////
  /////////////////////////////////////////////////////////////////////////////////////////

  /**
   * Changes the namespace prefix of this attribute.
   *
   * @param aNamespacePrefix The new namespace prefix.
   */
  public void setNamespacePrefix(String aNamespacePrefix) {
    _theNamespacePrefix = aNamespacePrefix;
  }

  /**
   * Changes the name of this attribute.
   *
   * @param aName The new name.
   */
  public void setName(String aName) {
    _theName = aName;
  }

  /**
   * Changes the value of this attribute.
   *
   * @param aValue The new value.
   */
  public void setValue(String aValue) {
    _theValue = aValue;
  }

  /////////////////////////////////////////////////////////////////////////////////////////
  //////////////////////////////////  OVERRIDEN METHODS  //////////////////////////////////
  /////////////////////////////////////////////////////////////////////////////////////////

  /**
   * Returns a string representation of this attribute.
   *
   * @return A string representation of this attribute.
   */
  public String toString() {
    StringBuffer aBuffer = new StringBuffer(super.toString());
    aBuffer.append("[namespacePrefix=").append(_theNamespacePrefix)
           .append(" name=").append(_theName).append(" value=").append(_theValue)
           .append("]");

    return aBuffer.toString();
  }
}