Class PhotonMetaElements

java.lang.Object
com.helger.photon.app.html.PhotonMetaElements

@ThreadSafe public final class PhotonMetaElements extends Object
This class keeps track of all the meta elements that must be included globally or for a single request.
Author:
Philip Helger
  • Field Details

  • Method Details

    • _readMetaElements

      public static void _readMetaElements(@Nonnull com.helger.commons.io.resource.IReadableResource aRes, @Nonnull com.helger.html.meta.MetaElementList aTarget)
    • readMetaElementsForGlobal

      public static void readMetaElementsForGlobal(@Nonnull com.helger.commons.io.resource.IReadableResource aRes)
    • registerMetaElementForGlobal

      public static void registerMetaElementForGlobal(@Nonnull com.helger.html.meta.IMetaElement aMetaElement)
      Register a new meta element for global scope.
      Parameters:
      aMetaElement - The meta element to use. May not be null.
    • unregisterMetaElementForGlobal

      public static void unregisterMetaElementForGlobal(@Nullable String sMetaElementName)
      Unregister an existing meta element for global scope.
      Parameters:
      sMetaElementName - The meta element name to be removed. May not be null.
    • unregisterAllMetaElementsFromGlobal

      public static void unregisterAllMetaElementsFromGlobal()
      Unregister all existing meta elements from global scope.
    • getAllRegisteredMetaElementsForGlobal

      @Nonnull @ReturnsMutableCopy public static com.helger.commons.collection.impl.ICommonsList<com.helger.html.meta.IMetaElement> getAllRegisteredMetaElementsForGlobal()
      Returns:
      A non-null set with all meta elements to be included globally.
    • getAllRegisteredMetaElementsForGlobal

      public static void getAllRegisteredMetaElementsForGlobal(@Nonnull Collection<? super com.helger.html.meta.IMetaElement> aTarget)
    • hasRegisteredMetaElementsForGlobal

      public static boolean hasRegisteredMetaElementsForGlobal()
      Returns:
      true if at least a single meta element has been registered globally.
    • registerMetaElementForThisRequest

      public static void registerMetaElementForThisRequest(@Nonnull com.helger.html.meta.IMetaElement aMetaElement)
      Register a new meta element only for this request
      Parameters:
      aMetaElement - The meta element to use. May not be null.
    • unregisterMetaElementFromThisRequest

      public static void unregisterMetaElementFromThisRequest(@Nullable String sMetaElementName)
      Unregister an existing meta element only from this request
      Parameters:
      sMetaElementName - The name of the meta element to be removed. May not be null.
    • unregisterAllMetaElementsFromThisRequest

      public static void unregisterAllMetaElementsFromThisRequest()
      Unregister all existing meta elements from this request
    • getAllRegisteredMetaElementsForThisRequest

      @Nonnull @ReturnsMutableCopy public static com.helger.commons.collection.impl.ICommonsList<com.helger.html.meta.IMetaElement> getAllRegisteredMetaElementsForThisRequest()
      Returns:
      A non-null set with all meta elements to be included in this request.
    • getAllRegisteredMetaElementsForThisRequest

      public static void getAllRegisteredMetaElementsForThisRequest(@Nonnull Collection<? super com.helger.html.meta.IMetaElement> aTarget)
    • hasRegisteredMetaElementsForThisRequest

      public static boolean hasRegisteredMetaElementsForThisRequest()
      Returns:
      true if at least a single CSS path has been registered for this request only