com.helger.html.jscode.JSArray Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-html-jscode Show documentation
Java library to programmtically create JavaScript in a structured way
The newest version!
/**
 * 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.jscode;

import java.math.BigDecimal;
import java.math.BigInteger;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.CollectionHelper;
import com.helger.commons.collection.ext.CommonsArrayList;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.ToStringGenerator;
import com.helger.html.hc.IHCNode;
import com.helger.html.hc.render.HCRenderer;
import com.helger.json.IJson;

/**
 * array creation and initialization.
 *
 * @author Philip Helger
 */
public class JSArray extends AbstractJSExpression
{
  private ICommonsList  m_aExprs;

  public JSArray ()
  {}

  public boolean isEmpty ()
  {
    return m_aExprs == null || m_aExprs.isEmpty ();
  }

  @Nonnegative
  public int size ()
  {
    return m_aExprs == null ? 0 : m_aExprs.size ();
  }

  @Nonnull
  public JSArray add (final boolean bValue)
  {
    return add (JSExpr.lit (bValue));
  }

  @Nonnull
  public JSArray add (final char cValue)
  {
    return add (JSExpr.lit (cValue));
  }

  @Nonnull
  public JSArray add (final double dValue)
  {
    return add (JSExpr.lit (dValue));
  }

  @Nonnull
  public JSArray add (final float fValue)
  {
    return add (JSExpr.lit (fValue));
  }

  @Nonnull
  public JSArray add (final int nValue)
  {
    return add (JSExpr.lit (nValue));
  }

  @Nonnull
  public JSArray add (final long nValue)
  {
    return add (JSExpr.lit (nValue));
  }

  @Nonnull
  public JSArray add (@Nullable final BigDecimal aValue)
  {
    return add (aValue == null ? JSExpr.NULL : JSExpr.lit (aValue));
  }

  @Nonnull
  public JSArray add (@Nullable final BigInteger aValue)
  {
    return add (aValue == null ? JSExpr.NULL : JSExpr.lit (aValue));
  }

  @Nonnull
  public JSArray add (@Nullable final String sValue)
  {
    return add (sValue == null ? JSExpr.NULL : JSExpr.lit (sValue));
  }

  @Nonnull
  public JSArray add (@Nullable final IJson aValue)
  {
    return add (aValue == null ? JSExpr.NULL : JSExpr.json (aValue));
  }

  @Nonnull
  public JSArray add (@Nullable final IHCNode aValue)
  {
    return add (aValue == null ? null : HCRenderer.getAsHTMLStringWithoutNamespaces (aValue));
  }

  @Nonnull
  public JSArray addAll (@Nonnull final boolean... aCont)
  {
    for (final boolean bValue : aCont)
      add (bValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final char... aCont)
  {
    for (final char cValue : aCont)
      add (cValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final double... aCont)
  {
    for (final double dValue : aCont)
      add (dValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final float... aCont)
  {
    for (final float fValue : aCont)
      add (fValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final int... aCont)
  {
    for (final int nValue : aCont)
      add (nValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final long... aCont)
  {
    for (final long nValue : aCont)
      add (nValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final BigDecimal... aCont)
  {
    for (final BigDecimal aValue : aCont)
      add (aValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final BigInteger... aCont)
  {
    for (final BigInteger aValue : aCont)
      add (aValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final String... aCont)
  {
    for (final String sValue : aCont)
      add (sValue);
    return this;
  }

  @Nonnull
  public JSArray addAll (@Nonnull final Iterable  aCont)
  {
    for (final String sValue : aCont)
      add (sValue);
    return this;
  }

  @Nonnull
  public JSArray addAllExpr (@Nonnull final IJSExpression... aCont)
  {
    for (final IJSExpression aExpr : aCont)
      add (aExpr);
    return this;
  }

  @Nonnull
  public JSArray addAllExpr (@Nonnull final Iterable  aCont)
  {
    for (final IJSExpression aExpr : aCont)
      add (aExpr);
    return this;
  }

  /**
   * Add an element to the array initializer
   *
   * @param aExpr
   *        Expression to add. May not be null.
   * @return this
   */
  @Nonnull
  public JSArray add (@Nonnull final IJSExpression aExpr)
  {
    ValueEnforcer.notNull (aExpr, "Expr");

    if (m_aExprs == null)
      m_aExprs = new CommonsArrayList <> ();
    m_aExprs.add (aExpr);
    return this;
  }

  @Nonnull
  public JSArray remove (@Nonnegative final int nIndex)
  {
    if (m_aExprs != null)
      m_aExprs.remove (nIndex);
    return this;
  }

  @Nonnull
  @ReturnsMutableCopy
  public ICommonsList  getAll ()
  {
    return CollectionHelper.newList (m_aExprs);
  }

  public void generate (@Nonnull final JSFormatter aFormatter)
  {
    aFormatter.plain ('[');
    if (m_aExprs != null)
      aFormatter.generatable (m_aExprs);
    aFormatter.plain (']');
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!super.equals (o))
      return false;
    final JSArray rhs = (JSArray) o;
    return EqualsHelper.equals (m_aExprs, rhs.m_aExprs);
  }

  @Override
  public int hashCode ()
  {
    return HashCodeGenerator.getDerived (super.hashCode ()).append (m_aExprs).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ()).append ("exprs", m_aExprs).toString ();
  }
}