1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.renderer.reference.link

File URILabelGenerator.java

 

Code metrics

0
0
0
1
41
8
0
-
-
0
-

Classes

Class Line # Actions
URILabelGenerator 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.renderer.reference.link;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.rendering.listener.reference.ResourceReference;
24   
25    /**
26    * Generate Resource Reference labels for URIs. For example an implementation for MAILTO URIs would remove the scheme
27    * part and the query string part.
28    *
29    * @version $Id: f32385565e9c4f7a3c374d131ea03098da5e54f2 $
30    * @since 2.2RC1
31    */
32    @Role
 
33    public interface URILabelGenerator
34    {
35    /**
36    * @param reference the reference pointing to a URI for which we want to generate a label
37    * @return the URI label to display when rendering resource references
38    * @since 2.5RC1
39    */
40    String generateLabel(ResourceReference reference);
41    }