wamblee.org Git - utils/blob - 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.
  22  * Different component objects should never share ProvidedInterface instances!
  23  *
  24  * @author Erik Brakkee
  25  */
  26 public interface ProvidedInterface {
  27
  28         /**
  29          * Symbolic name for the service as used by the subsystem.
  30          * @return Service name.
  31          */
  32         String getName();
  33
  34         /**
  35          * Returns the service type.
  36          * @return Service type.
  37          */
  38         Class[] getInterfaceTypes();
  39
  40         /**
  41          * Publishes an implementation of the interface. The implementation must
  42          * call {@link Scope#publishInterface(ProvidedInterface, Object)} to publish the
  43          * interface implementation in a given scope.
  44          * @param aImplementation Implementation to publish.
  45          * @param aScope Scope in which to publish the implementation.
  46          */
  47         void publish(Object aImplementation, Scope aScope);
  48
  49
  50         /**
  51          * Determines whether the current provided interface exceeds the given provided interface.
  52          * In other words if it can provide at least what the given provided interface can provide.
  53          * @param aInterface Interface to compare to.
  54          * @return True if the current interface exceeds the given provided interface.
  55          */
  56         boolean covers(ProvidedInterface aInterface);
  57 }