1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.model.reference

File PageReferenceResolver.java

 

Code metrics

0
0
0
1
58
14
0
-
-
0
-

Classes

Class Line # Actions
PageReferenceResolver 39 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.model.reference;
21   
22    import java.lang.reflect.ParameterizedType;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.component.util.DefaultParameterizedType;
26    import org.xwiki.stability.Unstable;
27   
28    /**
29    * Resolve a Page reference defined in a given representation into a validated {@link PageReference} object, ie with
30    * valid values and a valid hierarchy (eg a Page reference must have a parent which is a space reference, reference
31    * values must not be null, etc).
32    *
33    * @version $Id: b80c670709b891b574189013124404e05e7fe1c3 $
34    * @since 10.6RC1
35    * @param <T> the type of the representation (eg a String)
36    */
37    @Role
38    @Unstable
 
39    public interface PageReferenceResolver<T>
40    {
41    /**
42    * Type instance for {@code PageReferenceResolver<String>}.
43    */
44    ParameterizedType TYPE_STRING = new DefaultParameterizedType(null, PageReferenceResolver.class, String.class);
45   
46    /**
47    * Type instance for {@code PageReferenceResolver<EntityReference>}.
48    */
49    ParameterizedType TYPE_REFERENCE =
50    new DefaultParameterizedType(null, PageReferenceResolver.class, EntityReference.class);
51   
52    /**
53    * @param pageReferenceRepresentation the representation of a page reference (eg as a String)
54    * @param parameters optional parameters. Their meaning depends on the resolver implementation
55    * @return the valid resolved page reference as an Object
56    */
57    PageReference resolve(T pageReferenceRepresentation, Object... parameters);
58    }