| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| IWikiReferenceParser | 29 | 0 | - | 0 | 0 |
| 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.wikimodel; | |
| 21 | ||
| 22 | /** | |
| 23 | * Instances of this type are used to transform references found in wiki | |
| 24 | * documents into corresponding structured objects - {@link WikiReference}. | |
| 25 | * | |
| 26 | * @author kotelnikov | |
| 27 | * @see WikiReference | |
| 28 | */ | |
| 29 | public interface IWikiReferenceParser | |
| 30 | { | |
| 31 | /** | |
| 32 | * Parses the given reference, recognizes individual parts of this reference | |
| 33 | * (link, label, parameters) and returns the corresponding reference object. | |
| 34 | * | |
| 35 | * @param str the reference to parse | |
| 36 | * @return a wiki reference corresponding to the given link | |
| 37 | */ | |
| 38 | WikiReference parse(String str); | |
| 39 | } |