1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.lesscss.internal.colortheme

File LESSColorThemeConverter.java

 

Code metrics

0
0
0
1
54
9
0
-
-
0
-

Classes

Class Line # Actions
LESSColorThemeConverter 34 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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.internal.colortheme;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.lesscss.compiler.LESSCompilerException;
24   
25    /**
26    * Component to parse a LESS skin file and to return a Color Theme from it.
27    *
28    * This component must cache its results in an instance of {@link org.xwiki.lesscss.internal.cache.ColorThemeCache}.
29    *
30    * @since 7.0RC1
31    * @version $Id: f278aedb9081fef6a0ecedf0f8704adbad2da4dc $
32    */
33    @Role
 
34    public interface LESSColorThemeConverter
35    {
36    /**
37    * Get a color theme from a LESS file, located in the current skin.
38    * @param fileName name of the LESS file
39    * @param force force the computation, even if the output is already in the cache (not recommended)
40    * @return the computed Color Theme
41    * @throws org.xwiki.lesscss.compiler.LESSCompilerException if problem occurs
42    */
43    ColorTheme getColorThemeFromSkinFile(String fileName, boolean force) throws LESSCompilerException;
44   
45    /**
46    * Get a color theme from a LESS file, located in the specified skin.
47    * @param fileName name of the LESS file
48    * @param skin name of the skin where the LESS file is located
49    * @param force force the computation, even if the output is already in the cache (not recommended)
50    * @return the computed Color Theme
51    * @throws LESSCompilerException if problem occurs
52    */
53    ColorTheme getColorThemeFromSkinFile(String fileName, String skin, boolean force) throws LESSCompilerException;
54    }