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

File EntityReferenceValueProvider.java

 

Code metrics

0
0
0
1
44
9
0
-
-
0
-

Classes

Class Line # Actions
EntityReferenceValueProvider 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 org.xwiki.component.annotation.Role;
23    import org.xwiki.model.EntityType;
24   
25    /**
26    * Return default values for specified Entity Reference types. Useful when an Entity Reference value has not been
27    * specified and we need to find a default value for it (the default value returned will depend on the implementations,
28    * some will return default values defined in the XWiki configuration, others will return values taken from the current
29    * document reference, etc).
30    *
31    * @version $Id: 705c813aa2e0e30fab46c0e6d579e6eb906e7614 $
32    * @since 2.3M1
33    * @deprecated since 7.2M1, use {@link EntityReferenceProvider} instead
34    */
35    @Role
36    @Deprecated
 
37    public interface EntityReferenceValueProvider
38    {
39    /**
40    * @param type the entity reference type for which to get the default value
41    * @return the default value for the passed type
42    */
43    String getDefaultValue(EntityType type);
44    }