001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.autoconfigure.template;
018
019import org.springframework.core.env.Environment;
020import org.springframework.core.io.ResourceLoader;
021
022/**
023 * Indicates the availability of view templates for a particular templating engine such as
024 * FreeMarker or Thymeleaf.
025 *
026 * @author Andy Wilkinson
027 * @since 1.1.0
028 */
029@FunctionalInterface
030public interface TemplateAvailabilityProvider {
031
032        /**
033         * Returns {@code true} if a template is available for the given {@code view}.
034         * @param view the view name
035         * @param environment the environment
036         * @param classLoader the class loader
037         * @param resourceLoader the resource loader
038         * @return if the template is available
039         */
040        boolean isTemplateAvailable(String view, Environment environment,
041                        ClassLoader classLoader, ResourceLoader resourceLoader);
042
043}