com.helger.photon.app.html.IHTMLProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-oton-app Show documentation

ph-oton basic application stuff

The newest version!

/*
 * 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.photon.app.html;

import javax.annotation.Nonnull;

import com.helger.html.hc.html.root.HCHtml;
import com.helger.web.scope.IRequestWebScopeWithoutResponse;

/**
 * Base interface for an HTML creator
 *
 * @author Philip Helger
 */
@FunctionalInterface
public interface IHTMLProvider
{
  /**
   * Create HTML for the provided request.
   *
   * @param aRequestScope
   *        The current request. Never null.
   * @return The created HTML content. May not be null.
   */
  @Nonnull
  HCHtml createHTML (@Nonnull IRequestWebScopeWithoutResponse aRequestScope);
}