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

File EntityReferenceResolver.java

 

Code metrics

0
0
0
1
62
13
0
-
-
0
-

Classes

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