Clover Coverage Report - XWiki Rendering - Parent POM 4.0-SNAPSHOT (Aggregated)
Coverage timestamp: Mon Mar 12 2012 18:03:13 CET
0   43   0   -
0   8   -   0
0     -  
1    
 
  ResourceReferenceParser       Line # 32 0 - 0 0 - -1.0
 
No Tests
 
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.parser;
21   
22    import org.xwiki.component.annotation.ComponentRole;
23    import org.xwiki.rendering.listener.reference.ResourceReference;
24   
25    /**
26    * Interface for parsing resource references (references to links, images, attachments, etc) for various wiki syntaxes.
27    *
28    * @version $Id$
29    * @since 2.5RC1
30    */
31    @ComponentRole
 
32    public interface ResourceReferenceParser
33    {
34    /**
35    * Parses a resource reference represented (reference to a link, image, attachment, etc) as a String into a
36    * {@link org.xwiki.rendering.listener.reference.ResourceReference} object.
37    *
38    * @param rawReference the string representation of the resource reference to parse (the supported syntax depends
39    * on the parser implementation used)
40    * @return the parsed resource reference
41    */
42    ResourceReference parse(String rawReference);
43    }