Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
LESSCompiler | 33 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.lesscss.compiler; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | import org.xwiki.lesscss.resources.LESSResourceReference; | |
24 | ||
25 | /** | |
26 | * The Integrated LESS Compiler is a LESS compiler that take care of the wiki context (skin and color themes) to | |
27 | * generate the appropriate CSS output. | |
28 | * | |
29 | * @since 6.4M2 | |
30 | * @version $Id: aa472ed3de7e005bc9714970818a7f21d4d2cf2b $ | |
31 | */ | |
32 | @Role | |
33 | public interface LESSCompiler | |
34 | { | |
35 | /** | |
36 | * Compile a LESS resource. | |
37 | * Velocity will also be parsed on the resource, but not on the files included via the @import directive. | |
38 | * Since the result is cached, do not put velocity code that needs to be always executed, unless you use the force | |
39 | * parameter. | |
40 | * | |
41 | * @param lessResourceReference reference of the LESS resource to compile | |
42 | * @param includeSkinStyle include the main LESS file of the skin in order to have variables and mix-ins | |
43 | * defined there | |
44 | * @param useVelocity either or not the resource be parsed by Velocity before compiling it | |
45 | * @param force force the computation, even if the output is already in the cache (not recommended) | |
46 | * @return the generated CSS | |
47 | * @throws LESSCompilerException if problems occur | |
48 | */ | |
49 | String compile(LESSResourceReference lessResourceReference, boolean includeSkinStyle, boolean useVelocity, | |
50 | boolean force) throws LESSCompilerException; | |
51 | ||
52 | /** | |
53 | * Compile a LESS resource. | |
54 | * Velocity will also be parsed on the resource, but not on the files included via the @import directive. | |
55 | * Since the result is cached, do not put velocity code that needs to be always executed, unless you use the force | |
56 | * parameter. | |
57 | * | |
58 | * @param lessResourceReference reference of the LESS resource to compile | |
59 | * @param includeSkinStyle include the main LESS file of the skin in order to have variables and mix-ins | |
60 | * defined there | |
61 | * @param skin name of the skin where the LESS file is located | |
62 | * @param useVelocity either or not the resource be parsed by Velocity before compiling it | |
63 | * @param force force the computation, even if the output is already in the cache (not recommended) | |
64 | * @return the generated CSS | |
65 | * @throws LESSCompilerException if problems occur | |
66 | */ | |
67 | String compile(LESSResourceReference lessResourceReference, boolean includeSkinStyle, boolean useVelocity, | |
68 | String skin, boolean force) throws LESSCompilerException; | |
69 | } |