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

File ObjectPropertyReferenceResolver.java

 

Code metrics

0
0
0
1
69
15
0
-
-
0
-

Classes

Class Line # Actions
ObjectPropertyReferenceResolver 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 Property reference defined in a given representation into a validated {@link ObjectPropertyReference}
29    * object, i.e. with valid values and a valid hierarchy (e.g. a Property reference must have a parent which is an object
30    * reference, reference values must not be null, etc).
31    *
32    * @param <T> the type of the representation (e.g. a String)
33    * @version $Id: e05bb83a0b791599bb32998eb4890e2ee0e913d5 $
34    * @since 2.3M1
35    */
36    @Role
 
37    public interface ObjectPropertyReferenceResolver<T>
38    {
39    /**
40    * Type instance for {@code ObjectPropertyReferenceResolver<String>}.
41    *
42    * @since 4.0M1
43    */
44    ParameterizedType TYPE_STRING = new DefaultParameterizedType(null, ObjectPropertyReferenceResolver.class,
45    String.class);
46   
47    /**
48    * Type instance for {@code ObjectPropertyReferenceResolver<EntityReference>}.
49    *
50    * @since 4.0M1
51    */
52    ParameterizedType TYPE_REFERENCE = new DefaultParameterizedType(null, ObjectPropertyReferenceResolver.class,
53    EntityReference.class);
54   
55    /**
56    * @param propertyReferenceRepresentation the representation of an object reference (e.g. as a String)
57    * @return the valid resolved object reference as an object
58    */
59    @Deprecated
60    ObjectPropertyReference resolve(T propertyReferenceRepresentation);
61   
62    /**
63    * @param propertyReferenceRepresentation the representation of an object reference (e.g. as a String)
64    * @param parameters optional parameters. Their meaning depends on the resolver implementation
65    * @return the valid resolved object reference as an object
66    * @since 3.3M2
67    */
68    ObjectPropertyReference resolve(T propertyReferenceRepresentation, Object... parameters);
69    }