com.helger.xml.microdom.IMicroDocument 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

There is a newer version: 11.1.8

/*
 * 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 com.helger.commons.state.ETriState;

/**
 * Represents a complete document.
 *
 * @author Philip Helger
 */
public interface IMicroDocument extends IMicroNodeWithChildren
{
  /**
   * @return The standalone value. Never null.
   * @since 9.3.5
   */
  @Nonnull
  ETriState getStandalone ();

  /**
   * @return true if the document is standalone, false
   *         if not. The default value is false.
   */
  default boolean isStandalone ()
  {
    return getStandalone ().isTrue ();
  }

  /**
   * Change the standalone state of this document.
   *
   * @param eStandalone
   *        The new value. May not be null.
   * @since 9.3.5
   */
  void setStandalone (@Nonnull ETriState eStandalone);

  /**
   * Change the standalone state of this document.
   *
   * @param bIsStandalone
   *        The new value. true for standalone, false
   *        if not.
   */
  default void setStandalone (final boolean bIsStandalone)
  {
    setStandalone (ETriState.valueOf (bIsStandalone));
  }

  /**
   * @return May be null.
   */
  @Nullable
  IMicroDocumentType getDocType ();

  /**
   * @return May be null.
   */
  @Nullable
  IMicroElement getDocumentElement ();

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