opendaylight/commons/concepts/src/main/java/org/opendaylight/controller/concepts/transform/InputClassBasedTransformer.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
   9 package org.opendaylight.controller.concepts.transform;
  10
  11 /**
  12  * Input class based transformer
  13  *
  14  * {@link Transformer} which accepts / transforms only specific classes of
  15  * input, and is useful if the selection of transformer should be based on the
  16  * class of the input and there is one-to-one mapping between input class and
  17  * transformer.
  18  *
  19  *
  20  * @author Tony Tkacik
  21  *
  22  * @param <S>
  23  *            Common supertype of input
  24  * @param <I>
  25  *            Concrete type of input
  26  * @param <P>
  27  *            Product
  28  */
  29 public interface InputClassBasedTransformer<S, I extends S, P> extends
  30         Transformer<I, P> {
  31
  32     /**
  33      * Returns an {@link Class} of input which is acceptable for transformation.
  34      *
  35      * @return {@link Class} of input which is acceptable for transformation.
  36      */
  37     Class<? extends S> getInputClass();
  38 }