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