opendaylight/commons/concepts/src/main/java/org/opendaylight/controller/concepts/transform/RuleBasedTransformer.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.transform;\r
  10 \r
  11 import java.util.Set;\r
  12 \r
  13 /**\r
  14  * Transformer with set of acceptance rules\r
  15  * \r
  16  * The transformer provides a set of {@link Acceptor}s, which could be used to\r
  17  * verify if the input will produce result using the transformer.\r
  18  * \r
  19  * The transormer is able to produce result if ANY of associated\r
  20  * {@link Acceptor}s accepted result.\r
  21  * \r
  22  * @author Tony Tkacik\r
  23  * \r
  24  * @param <I>\r
  25  *            Input class for transformation\r
  26  * @param <P>\r
  27  *            Product of transformation\r
  28  */\r
  29 public interface RuleBasedTransformer<I, P> extends Transformer<I, P> {\r
  30 \r
  31     /**\r
  32      * Set of {@link Acceptor}, which could be used to verify if the input is\r
  33      * usable by transformer.\r
  34      * \r
  35      * The transformer is able to produce result if ANY of associated\r
  36      * {@link Acceptor}s accepted result.\r
  37      * \r
  38      * @return Set of input acceptance rules associated to this transformer.\r
  39      */\r
  40     Set<Acceptor<I>> getRules();\r
  41 \r
  42 }\r