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

File InterWikiResourceReference.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
4
3
1
65
18
3
0.75
1.33
3
1

Classes

Class Line # Actions
InterWikiResourceReference 32 4 0% 3 0
1.0100%
 

Contributing tests

This file is covered by 12 tests. .

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.listener.reference;
21   
22    /**
23    * Represents a reference to an external wiki(<a href="http://en.wikipedia.org/wiki/InterWiki">Inter Wiki</a>).
24    * An InterWiki reference is a shorthand notation to reference a set of external URL, all having a common prefix (eg
25    * http://server/some/common/prefix/a1, http://server/some/common/prefix/a2). An InterWiki reference is made of an
26    * InterWiki Alias which is a name corresponding to the common URL and an InterWiki Path which is the suffix to append
27    * to the common URL part to make the full URL.
28    *
29    * @version $Id: c81cb0fa4b4aa35efda8f5caa623bafb7d4b4131 $
30    * @since 2.5RC1
31    */
 
32    public class InterWikiResourceReference extends ResourceReference
33    {
34    /**
35    * The name of the parameter representing the InterWiki Alias.
36    */
37    public static final String INTERWIKI_ALIAS = "interWikiAlias";
38   
39    /**
40    * @param reference see {@link #getReference()}
41    */
 
42  21 toggle public InterWikiResourceReference(String reference)
43    {
44  21 super(reference, ResourceType.INTERWIKI);
45  21 setTyped(true);
46    }
47   
48    /**
49    * @param interWikiAlias see {@link #getInterWikiAlias()}
50    */
 
51  21 toggle public void setInterWikiAlias(String interWikiAlias)
52    {
53  21 setParameter(INTERWIKI_ALIAS, interWikiAlias);
54    }
55   
56    /**
57    * @return the <a href="http://en.wikipedia.org/wiki/InterWiki">Inter Wiki</a> alias to which the resource is
58    * pointing to or null if not defined. Mappings between Inter Wiki aliases and actual locations are defined
59    * in the Inter Wiki Map. Example: "wikipedia"
60    */
 
61  5 toggle public String getInterWikiAlias()
62    {
63  5 return getParameter(INTERWIKI_ALIAS);
64    }
65    }