001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 */
016package org.kuali.rice.krad.theme.preprocessor;
017
018import java.io.File;
019import java.util.Properties;
020
021/**
022 * Theme pre processors are registered with {@link org.kuali.rice.krad.theme.ThemeBuilder} and invoked on
023 * each theme processed
024 *
025 * <p>
026 * Pre processors are invoked after overlays for the theme have been applied, but before any merging and
027 * minification. Therefore they can create or modify assets for the theme
028 * </p>
029 *
030 * <p>
031 * Pre processors may also have configuration that is supplied through the theme properties
032 * </p>
033 *
034 * @author Kuali Rice Team (rice.collab@kuali.org)
035 */
036public interface ThemePreProcessor {
037
038    /**
039     * Invoked to perform processing on the given theme
040     *
041     * @param themeName name of the theme to process
042     * @param themeDirectory directory containing the theme assets
043     * @param themeProperties properties for the theme containing its configuration
044     */
045    public void processTheme(String themeName, File themeDirectory, Properties themeProperties);
046}