com.helger.xml.microdom.IMicroAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-xml Show documentation
Java 1.8+ Library with XML handling routines
The newest version!
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.xml.microdom;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.namespace.QName;

import com.helger.commons.lang.ICloneable;
import com.helger.commons.state.EChange;

/**
 * Represents a single attribute within an element (=tag).
 *
 * @author Philip Helger
 */
public interface IMicroAttribute extends ICloneable 
{
  /**
   * Get the namespace URI of this attribute
   *
   * @return May be null if this attribute has no namespace URI.
   */
  @Nullable
  default String getNamespaceURI ()
  {
    return getAttributeQName ().getNamespaceURI ();
  }

  /**
   * Check if this attribute has a specified namespace URI.
   *
   * @return true if this attribute has a specified namespace URI,
   *         false otherwise
   */
  default boolean hasNamespaceURI ()
  {
    return getAttributeQName ().hasNamespaceURI ();
  }

  /**
   * Check if this attribute has no namespace URI.
   *
   * @return true if this attribute has no namespace URI,
   *         false otherwise
   */
  default boolean hasNoNamespaceURI ()
  {
    return getAttributeQName ().hasNoNamespaceURI ();
  }

  /**
   * Check if this attribute has the specified namespace URI.
   *
   * @param sNamespaceURI
   *        The namespace URI to check. May not be null.
   * @return true if this attribute has the specified namespace
   *         URI, false otherwise
   */
  default boolean hasNamespaceURI (@Nullable final String sNamespaceURI)
  {
    return getAttributeQName ().hasNamespaceURI (sNamespaceURI);
  }

  /**
   * Get the (local) name of the attribute. It never contains XML schema
   * prefixes or the like.
   *
   * @return The name of the attribute and never null.
   */
  @Nonnull
  default String getAttributeName ()
  {
    return getAttributeQName ().getName ();
  }

  /**
   * Get the qualified name of the attribute. It never contains XML schema
   * prefixes or the like.
   *
   * @return The qualified name (namespace URI + local name) of the attribute
   *         and never null.
   */
  @Nonnull
  IMicroQName getAttributeQName ();

  /**
   * @return The regular XML QName of this attribute using an empty prefix.
   */
  @Nonnull
  default QName getAsXMLQName ()
  {
    return getAttributeQName ().getAsXMLQName ();
  }

  /**
   * @param sPrefix
   *        the namespace prefix to be used in the resulting object. May not be
   *        null but maybe empty.
   * @return The regular XML QName of this attribute using the provided prefix.
   */
  @Nonnull
  default QName getAsXMLQName (@Nonnull final String sPrefix)
  {
    return getAttributeQName ().getAsXMLQName (sPrefix);
  }

  /**
   * @return The value associated with this attribute. Never null.
   */
  @Nonnull
  String getAttributeValue ();

  /**
   * Set the value of the attribute.
   *
   * @param sAttributeValue
   *        The new value to be set. May not be null.
   * @return {@link EChange}.
   */
  @Nonnull
  EChange setAttributeValue (@Nonnull String sAttributeValue);

  /**
   * {@inheritDoc}
   */
  @Nonnull
  IMicroAttribute getClone ();
}