wamblee.org Git - utils/blob - 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 /**
  19  * DOCUMENT ME!
  20  *
  21  * @author $author$
  22  * @version $Revision: 1.6 $
  23   */
  24 public interface RequiredInterface extends NamedInterface {
  25     /**
  26      * DOCUMENT ME!
  27      *
  28      * @return True iff the required interface is optional.
  29      */
  30     boolean isOptional();
  31
  32     /**
  33      * Checks if the service is provided by a given provided interface.
  34      *
  35      * @param aInterface Provided interface.
  36      *
  37      * @return
  38      */
  39     boolean implementedBy(ProvidedInterface aInterface);
  40
  41     /**
  42      * Sets the provider of this interface.
  43      *
  44      * @param aProvider Provider.
  45      */
  46     void setProvider(ProvidedInterface aProvider);
  47
  48     /**
  49      * Gets the provider interface.
  50      *
  51      * @return Provider or null if not set.
  52      */
  53     ProvidedInterface getProvider();
  54
  55     /**
  56      * Determines if the requirements of the current interface are at
  57      * least those of the given required interface.
  58      *
  59      * @param aInterface DOCUMENT ME!
  60      *
  61      * @return DOCUMENT ME!
  62      */
  63     boolean covers(RequiredInterface aInterface);
  64 }