com.helger.html.js.JSWriterSettings Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2016 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.html.js;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.lang.ICloneable;
import com.helger.commons.string.ToStringGenerator;
import com.helger.commons.system.ENewLineMode;

/**
 * Settings for the textual representation of JSDOM objects
 *
 * @author Philip Helger
 */
@NotThreadSafe
public class JSWriterSettings implements IJSWriterSettings, ICloneable 
{
  private boolean m_bIndentAndAlign;
  private boolean m_bGenerateComments;
  private String m_sIndent;
  private ENewLineMode m_eNewLineMode;

  public JSWriterSettings ()
  {
    m_bIndentAndAlign = JSWriterDefaultSettings.isIndentAndAlign ();
    m_bGenerateComments = JSWriterDefaultSettings.isGenerateComments ();
    m_sIndent = JSWriterDefaultSettings.getIndent ();
    m_eNewLineMode = JSWriterDefaultSettings.getNewLineMode ();
  }

  public JSWriterSettings (@Nonnull final IJSWriterSettings aOther)
  {
    ValueEnforcer.notNull (aOther, "Other");
    m_bIndentAndAlign = aOther.isIndentAndAlign ();
    m_bGenerateComments = aOther.isGenerateComments ();
    m_sIndent = aOther.getIndent ();
    m_eNewLineMode = aOther.getNewLineMode ();
  }

  public boolean isIndentAndAlign ()
  {
    return m_bIndentAndAlign;
  }

  @Nonnull
  public JSWriterSettings setIndentAndAlign (final boolean bIndentAndAlign)
  {
    m_bIndentAndAlign = bIndentAndAlign;
    return this;
  }

  public boolean isGenerateComments ()
  {
    return m_bGenerateComments;
  }

  @Nonnull
  public JSWriterSettings setGenerateComments (final boolean bGenerateComments)
  {
    m_bGenerateComments = bGenerateComments;
    return this;
  }

  /**
   * This is a wrapper around {@link #setIndentAndAlign(boolean)}, { and
   * {@link #setGenerateComments(boolean)}
   *
   * @param bMinimumCodeSize
   *        true for minimum code size
   * @return this
   */
  @Nonnull
  public JSWriterSettings setMinimumCodeSize (final boolean bMinimumCodeSize)
  {
    setIndentAndAlign (!bMinimumCodeSize);
    setGenerateComments (!bMinimumCodeSize);
    return this;
  }

  @Nonnull
  @Nonempty
  public String getIndent ()
  {
    return m_sIndent;
  }

  @Nonnull
  public JSWriterSettings setIndent (@Nonnull @Nonempty final String sIndent)
  {
    m_sIndent = ValueEnforcer.notEmpty (sIndent, "Indent");
    return this;
  }

  @Nonnull
  public JSWriterSettings setNewLineMode (@Nonnull final ENewLineMode eNewLineMode)
  {
    m_eNewLineMode = ValueEnforcer.notNull (eNewLineMode, "NewLineMode");
    return this;
  }

  @Nonnull
  public ENewLineMode getNewLineMode ()
  {
    return m_eNewLineMode;
  }

  @Nonnull
  @Nonempty
  public String getNewLineString ()
  {
    return m_eNewLineMode.getText ();
  }

  @Nonnull
  @ReturnsMutableCopy
  public JSWriterSettings getClone ()
  {
    return new JSWriterSettings (this);
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("IndentAndAlign", m_bIndentAndAlign)
                                       .append ("GenerateComments", m_bGenerateComments)
                                       .append ("Indent", m_sIndent)
                                       .append ("NewLineMode", m_eNewLineMode)
                                       .toString ();
  }

  @Nonnull
  @ReturnsMutableCopy
  public static JSWriterSettings createCloneOnDemand (@Nullable final IJSWriterSettings aSettings)
  {
    return aSettings == null ? new JSWriterSettings () : new JSWriterSettings (aSettings);
  }
}