Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
ElementParser | 33 | 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 | ||
21 | package org.xwiki.security.authorization.testwikis.internal.parser; | |
22 | ||
23 | import org.xwiki.model.reference.EntityReferenceResolver; | |
24 | import org.xwiki.model.reference.EntityReferenceSerializer; | |
25 | import org.xwiki.security.authorization.testwikis.TestDefinition; | |
26 | ||
27 | /** | |
28 | * Interface implemented by the WML parser and provided to factories. | |
29 | * | |
30 | * @version $Id: c85ccbd36fcd2179ccfe6c61c133455d0cebfe5a $ | |
31 | * @since 5.0M2 | |
32 | */ | |
33 | public interface ElementParser | |
34 | { | |
35 | /** | |
36 | * Register a factory for current parsing level. | |
37 | * @param handler a factory. | |
38 | */ | |
39 | void register(EntityFactory handler); | |
40 | ||
41 | /** | |
42 | * Format a message (like String.format) and add the current parser location at the end. | |
43 | * @param format a format string | |
44 | * @param objects arguments for the format string | |
45 | * @return a formatted string with parser location at the end. | |
46 | */ | |
47 | String getLocatedMessage(String format, Object... objects); | |
48 | ||
49 | /** | |
50 | * @return the root entity created for the current parsing (available only during parsing) | |
51 | */ | |
52 | TestDefinition getWikis(); | |
53 | ||
54 | /** | |
55 | * @return an entity resolver that could be used by factories (available only during parsing) | |
56 | */ | |
57 | EntityReferenceResolver<String> getResolver(); | |
58 | ||
59 | /** | |
60 | * @return an entity serializer that could be used by factories (available only during parsing) | |
61 | */ | |
62 | EntityReferenceSerializer<String> getSerializer(); | |
63 | } |