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

File ComponentDependencyFactory.java

 

Code metrics

0
0
0
1
44
7
0
-
-
0
-

Classes

Class Line # Actions
ComponentDependencyFactory 36 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.component.annotation;
21   
22    import java.lang.reflect.Field;
23   
24    import org.xwiki.component.descriptor.ComponentDependency;
25   
26    /**
27    * Allows creating {@link ComponentDependency} instances from a Method {@link Field}. There can be several
28    * implementations, for example one using {@code @Inject} and {@code @Named} annotations to describe a Component
29    * Dependency. Note that this interface allows cleanly plugging new implementations to extend how Component Descriptor
30    * are recognized. This allows for example to cleanly support legacy implementation (for example to use the old
31    * {@code @Requirement} annotations we used to use).
32    *
33    * @version $Id: 2c4cf2802b53ed9838e8577c6e1dc2a94d2de8f2 $
34    * @since 3.2RC1
35    */
 
36    public interface ComponentDependencyFactory
37    {
38    /**
39    * @param field the field for which to extract a Component Dependency
40    * @return the Component Dependency instance created from the passed field or null if the field doesn't match the
41    * requirements
42    */
43    ComponentDependency createComponentDependency(Field field);
44    }