1 /**
2 * Copyright 2005-2014 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.theme.preprocessor;
17
18 import java.io.File;
19 import java.util.Properties;
20
21 /**
22 * Theme pre processors are registered with {@link org.kuali.rice.krad.theme.ThemeBuilder} and invoked on
23 * each theme processed
24 *
25 * <p>
26 * Pre processors are invoked after overlays for the theme have been applied, but before any merging and
27 * minification. Therefore they can create or modify assets for the theme
28 * </p>
29 *
30 * <p>
31 * Pre processors may also have configuration that is supplied through the theme properties
32 * </p>
33 *
34 * @author Kuali Rice Team (rice.collab@kuali.org)
35 */
36 public interface ThemePreProcessor {
37
38 /**
39 * Invoked to perform processing on the given theme
40 *
41 * @param themeName name of the theme to process
42 * @param themeDirectory directory containing the theme assets
43 * @param themeProperties properties for the theme containing its configuration
44 */
45 public void processTheme(String themeName, File themeDirectory, Properties themeProperties);
46 }