opendaylight/commons/concepts/src/main/java/org/opendaylight/controller/concepts/tranform/InputClassBasedTransformer.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 \r
   9 package org.opendaylight.controller.concepts.tranform;\r
  10 \r
  11 /**\r
  12  * Input class based transformer\r
  13  * \r
  14  * {@link Transformer} which accepts / transforms only specific classes of\r
  15  * input, and is useful if the selection of transformer should be based on the\r
  16  * class of the input and there is one-to-one mapping between input class and\r
  17  * transformer.\r
  18  * \r
  19  * \r
  20  * @author Tony Tkacik\r
  21  * \r
  22  * @param <S>\r
  23  *            Common supertype of input\r
  24  * @param <I>\r
  25  *            Concrete type of input\r
  26  * @param <P>\r
  27  *            Product\r
  28  */\r
  29 public interface InputClassBasedTransformer<S, I extends S, P> extends\r
  30         Transformer<I, P> {\r
  31 \r
  32     /**\r
  33      * Returns an {@link Class} of input which is acceptable for transformation.\r
  34      * \r
  35      * @return {@link Class} of input which is acceptable for transformation.\r
  36      */\r
  37     Class<? extends S> getInputClass();\r
  38 }\r