(no commit message)
[utils] / system / general / src / main / java / org / wamblee / system / core / RequiredInterface.java
1 /*
2  * Copyright 2007 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */ 
16 package org.wamblee.system.core;
17
18 public interface RequiredInterface {
19
20         /**
21          * Name for the interface. 
22          */
23         String getName();
24         
25         /**
26          * @return True iff the required interface is optional. 
27          */
28         boolean isOptional(); 
29         
30         
31         /**
32          * Checks if the service is provided by a given provided interface. 
33          * @param aInterface Provided interface. 
34          * @return
35          */
36         boolean implementedBy(ProvidedInterface aInterface);
37         
38         /**
39          * Sets the provider of this interface. 
40          * @param aProvider Provider. 
41          */
42         void setProvider(ProvidedInterface aProvider);
43         
44         /**
45          * Gets the provider interface. 
46          * @return Provider or null if not set. 
47          */
48         ProvidedInterface getProvider(); 
49         
50         /**
51          * Gets the implementation of the required interface. 
52          * @param <T>
53          * @param aClass Interface type. 
54          * @return Interface implementation or null if not known yet. 
55          */
56         <T> T getImplementation(Class<T> aClass); 
57 }