com.helger.html.hc.special.IHCSpecialNodes 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.hc.special;

import java.io.Serializable;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.ext.ICommonsList;
import com.helger.commons.collection.ext.ICommonsOrderedMap;
import com.helger.css.media.ICSSMediaList;
import com.helger.html.js.IHasJSCode;
import com.helger.html.resource.css.ICSSCodeProvider;

/**
 * This interface represents all special nodes that can occur in an HTML
 * document: CSS files (<link rel="stylesheet" href="..."/>),
 * JS files (<script
 * href="...">) and inline JS code (
 * <script>...</script>).
 *
 * @author Philip Helger
 */
public interface IHCSpecialNodes extends Serializable
{
  /**
   * @return true if CSS files are present, false if
   *         not
   */
  boolean hasExternalCSSs ();

  /**
   * @return All CSS files as a map from media list to the list of matching
   *         files. Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsOrderedMap > getAllExternalCSSs ();

  /**
   * @return true if inline CSS to be included before the
   *         CSS files is present, false if not
   */
  boolean hasInlineCSSBeforeExternal ();

  /**
   * @return The inline CSS to be included before the files as a map from
   *         media list to the CSS code. May not be null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllInlineCSSBeforeExternal ();

  /**
   * @return true if inline CSS to be included after the CSS
   *         files is present, false if not
   */
  boolean hasInlineCSSAfterExternal ();

  /**
   * @return The inline CSS to be included after the files as a map from
   *         media list to the CSS code. May not be null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllInlineCSSAfterExternal ();

  /**
   * @return true if JS files are present, false if
   *         not
   */
  boolean hasExternalJSs ();

  /**
   * @return All JS files. Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  ICommonsList  getAllExternalJSs ();

  /**
   * @return true if inline JS is present, false if
   *         not
   */
  boolean hasInlineJSBeforeExternal ();

  /**
   * @return The inline JS. May not be null.
   */
  @Nonnull
  @ReturnsMutableCopy
  IHasJSCode getInlineJSBeforeExternal ();

  /**
   * @return true if inline JS is present, false if
   *         not
   */
  boolean hasInlineJSAfterExternal ();

  /**
   * @return The inline JS. May not be null.
   */
  @Nonnull
  @ReturnsMutableCopy
  IHasJSCode getInlineJSAfterExternal ();
}