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

File BlockReferenceResolver.java

 

Code metrics

0
0
0
1
41
7
0
-
-
0
-

Classes

Class Line # Actions
BlockReferenceResolver 33 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 org.xwiki.component.annotation.Role;
23   
24    /**
25    * Resolve a Block reference from the referenced instance or another representation into a validated
26    * {@link BlockReference} object.
27    *
28    * @param <T> the type of the representation (eg a Block)
29    * @version $Id: 27da123ec74d2b8a43f7c433cc8e1d4d1e8d8d5d $
30    * @since 6.0M1
31    */
32    @Role
 
33    public interface BlockReferenceResolver<T>
34    {
35    /**
36    * @param blockReferenceRepresentation the referenced instance or representation of a block reference
37    * @param parameters optional parameters. Their meaning depends on the resolver implementation
38    * @return the valid resolved block reference as an Object
39    */
40    BlockReference resolve(T blockReferenceRepresentation, Object... parameters);
41    }