com.phloc.html.hc.html5.HCRT Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-html Show documentation
There is a newer version: 4.4.9
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.html.hc.html5;

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

import com.phloc.commons.text.IPredefinedLocaleTextProvider;
import com.phloc.html.EHTMLElement;
import com.phloc.html.annotations.SinceHTML5;
import com.phloc.html.hc.IHCNode;

@SinceHTML5
public class HCRT extends AbstractHCRubyChild 
{
  public HCRT ()
  {
    super (EHTMLElement.RT);
  }

  /**
   * Create a new RT element with the passed child text
   * 
   * @param aChild
   *        The child text provider to be appended. May be null
   * @return The created HCRT element and never null
   */
  @Nonnull
  public static HCRT create (@Nullable final IPredefinedLocaleTextProvider aChild)
  {
    return new HCRT ().addChild (aChild);
  }

  /**
   * Create a new RT element with the passed child texts
   * 
   * @param aChildren
   *        The child texts to be appended. May be null
   * @return The created HCRT element and never null
   */
  @Nonnull
  public static HCRT create (@Nullable final IPredefinedLocaleTextProvider... aChildren)
  {
    return new HCRT ().addChildren (aChildren);
  }

  /**
   * Create a new RT element with the passed child text
   * 
   * @param sChild
   *        The child to be appended. May be null
   * @return The created HCRT element and never null
   */
  @Nonnull
  public static HCRT create (@Nullable final String sChild)
  {
    return new HCRT ().addChild (sChild);
  }

  /**
   * Create a new RT element with the passed child texts
   * 
   * @param aChildren
   *        The child texts to be appended. May be null
   * @return The created HCRT element and never null
   */
  @Nonnull
  public static HCRT create (@Nullable final String... aChildren)
  {
    return new HCRT ().addChildren (aChildren);
  }

  /**
   * Create a new RT element with the passed child node
   * 
   * @param aChild
   *        The child node to be appended. May be null
   * @return The created HCRT element and never null
   */
  @Nonnull
  public static HCRT create (@Nullable final IHCNode aChild)
  {
    return new HCRT ().addChild (aChild);
  }

  /**
   * Create a new RT element with the passed child nodes
   * 
   * @param aChildren
   *        The child nodes to be appended. May be null
   * @return The created HCRT element and never null
   */
  @Nonnull
  public static HCRT create (@Nullable final IHCNode... aChildren)
  {
    return new HCRT ().addChildren (aChildren);
  }

  /**
   * Create a new RT element with the passed child nodes
   * 
   * @param aChildren
   *        The child nodes to be appended. May be null
   * @return The created HCRT element and never null
   */
  @Nonnull
  public static HCRT create (@Nullable final Iterable  aChildren)
  {
    return new HCRT ().addChildren (aChildren);
  }
}