1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.transformation.icon

File IconTransformationConfiguration.java

 

Code metrics

0
0
0
1
49
9
0
-
-
0
-

Classes

Class Line # Actions
IconTransformationConfiguration 33 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.rendering.transformation.icon;
21   
22    import java.util.Properties;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * Configuration properties for the Icon transformation.
28    *
29    * @version $Id: 6b27db4c112005fa8dc764a98d208d39dce754a1 $
30    * @since 2.6RC1
31    */
32    @Role
 
33    public interface IconTransformationConfiguration
34    {
35    /**
36    * @return the mappings between a set of characters representing an icon (eg ":)", "(y)") and an icon name
37    * (eg "emoticon_smile", "thumbs_up")
38    */
39    Properties getMappings();
40   
41    /**
42    * Adds a new mapping between a set of characters representing an icon (eg ":)", "(y)") and an icon name
43    * (eg "emoticon_smile", "thumbs_up").
44    *
45    * @param iconCharacters the set of characters representing the icon
46    * @param iconName the icon name based on a well-known list of names
47    */
48    void addMapping(String iconCharacters, String iconName);
49    }