com.helger.xml.serialize.write.XMLIndentDeterminatorHTML 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-2023 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.serialize.write;

import java.util.Locale;
import java.util.Map;

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

import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;

/**
 * Implementation of {@link IXMLIndentDeterminator} for real HTML. It uses the
 * default indent and align mode except for <pre> and <code>
 * elements.
 *
 * @author Philip Helger
 */
public class XMLIndentDeterminatorHTML implements IXMLIndentDeterminator
{
  private static boolean _isPreOrCode (@Nonnull final String sTagName)
  {
    final String sUCTagName = sTagName.toUpperCase (Locale.US);
    return sUCTagName.equals ("PRE") || sUCTagName.equals ("CODE");
  }

  @Nonnull
  public EXMLSerializeIndent getIndentOuter (@Nullable final String sParentNamespaceURI,
                                             @Nullable final String sParentTagName,
                                             @Nullable final String sNamespaceURI,
                                             @Nonnull final String sTagName,
                                             @Nullable final Map  aAttrs,
                                             final boolean bHasChildren,
                                             @Nonnull final EXMLSerializeIndent eDefaultIndent)
  {
    if (StringHelper.hasText (sParentTagName) && _isPreOrCode (sParentTagName))
    {
      // Don't indent or align
      return EXMLSerializeIndent.NONE;
    }

    // Always use the default
    return eDefaultIndent;
  }

  @Nonnull
  public EXMLSerializeIndent getIndentInner (@Nullable final String sParentNamespaceURI,
                                             @Nullable final String sParentTagName,
                                             @Nullable final String sNamespaceURI,
                                             @Nonnull final String sTagName,
                                             @Nullable final Map  aAttrs,
                                             final boolean bHasChildren,
                                             @Nonnull final EXMLSerializeIndent eDefaultIndent)
  {
    if (_isPreOrCode (sTagName))
    {
      // Don't indent or align
      return EXMLSerializeIndent.NONE;
    }

    // Always use the default
    return eDefaultIndent;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    return true;
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).getToString ();
  }
}