Removed DOCUMENT ME comments that were generated and applied source code
[utils] / system / general / src / main / java / org / wamblee / system / core / ProvidedInterface.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 import java.util.Collection;
19
20 /**
21  * Represents an interface provided by a component. Different component objects
22  * should never share ProvidedInterface instances!
23  * 
24  * @author Erik Brakkee
25  */
26 public interface ProvidedInterface extends NamedInterface {
27     /**
28      * Returns the service type.
29      * 
30      * @return Service type.
31      */
32     Class[] getInterfaceTypes();
33
34     /**
35      * Determines whether the current provided interface exceeds the given
36      * provided interface. In other words if it can provide at least what the
37      * given provided interface can provide.
38      * 
39      * @param aInterface
40      *            Interface to compare to.
41      * 
42      * @return True if the current interface exceeds the given provided
43      *         interface.
44      */
45     boolean covers(ProvidedInterface aInterface);
46 }