opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/annotations/RequireInterface.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.config.api.annotations;
   9
  10 import java.lang.annotation.ElementType;
  11 import java.lang.annotation.Retention;
  12 import java.lang.annotation.RetentionPolicy;
  13 import java.lang.annotation.Target;
  14
  15 /**
  16  * Indicates what service interface is expected to be obtained as a dependency
  17  * of a module. This annotation must be present for each dependency setter in
  18  * {@link org.opendaylight.controller.config.spi.Module} M(X)Bean interface.
  19  * Together with name of dependent bean the {@link #value()} will be used to get
  20  * {@link ObjectName} of dependency.
  21  *
  22  * <p>
  23  * Example:<br>
  24  *
  25  * <code>
  26  *
  27  * @RequireInterface(value = ThreadPoolServiceInterface.class, optional =
  28  *                         false)<br/> void setThreadPool(ObjectName on);
  29  *                         </code>
  30  */
  31 @Retention(RetentionPolicy.RUNTIME)
  32 @Target(ElementType.METHOD)
  33 public @interface RequireInterface {
  34
  35     /**
  36      * Declares dependency on service interface.
  37      */
  38     Class<? extends AbstractServiceInterface> value();
  39
  40 }