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

File DocumentReferenceResolver.java

 

Code metrics

0
0
0
1
60
12
0
-
-
0
-

Classes

Class Line # Actions
DocumentReferenceResolver 37 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   
27    /**
28    * Resolve a Document reference defined in a given representation into a validated {@link DocumentReference} object, ie
29    * with valid values and a valid hierarchy (eg a Document reference must have a parent which is a space reference,
30    * reference values must not be null, etc).
31    *
32    * @version $Id: e3b84299fb413f33a3e8a246ef6980a74ace09f8 $
33    * @since 2.2M1
34    * @param <T> the type of the representation (eg a String)
35    */
36    @Role
 
37    public interface DocumentReferenceResolver<T>
38    {
39    /**
40    * Type instance for {@code DocumentReferenceResolver<String>}.
41    *
42    * @since 4.0M1
43    */
44    ParameterizedType TYPE_STRING = new DefaultParameterizedType(null, DocumentReferenceResolver.class, String.class);
45   
46    /**
47    * Type instance for {@code DocumentReferenceResolver<EntityReference>}.
48    *
49    * @since 4.0M1
50    */
51    ParameterizedType TYPE_REFERENCE = new DefaultParameterizedType(null, DocumentReferenceResolver.class,
52    EntityReference.class);
53   
54    /**
55    * @param documentReferenceRepresentation the representation of a document reference (eg as a String)
56    * @param parameters optional parameters. Their meaning depends on the resolver implementation
57    * @return the valid resolved document reference as an Object
58    */
59    DocumentReference resolve(T documentReferenceRepresentation, Object... parameters);
60    }