com.helger.commons.lang.IAppendable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation
Java 1.8+ Library with tons of utility classes required in all projects
There is a newer version: 11.1.10
/*
 * 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.commons.lang;

import java.util.Map;

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

import org.w3c.dom.Node;

/**
 * Defines a generic interface for appending objects to something.
 *
 * @author Philip Helger
 * @param 
 *        The implementation type.
 */
public interface IAppendable >
{
  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (boolean x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (byte x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (char x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (double x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (float x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (int x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (long x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (short x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable Object x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable Enum  x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable boolean [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable byte [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable char [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable double [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable float [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable int [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable long [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable short [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable Object [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable Enum  [] x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable Iterable  x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable Map  x);

  /**
   * @param x
   *        value to be appended
   * @return this
   */
  @Nonnull
  IMPLTYPE append (@Nullable Node x);
}