opendaylight/commons/concepts/src/main/java/org/opendaylight/controller/concepts/transform/SimpleConditionalTransformer.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  * Simple condition-based transformer
  13  *
  14  * The transformer provides {@link #isAcceptable(Object)} method,
  15  * which could be used to query transformer if the input will produce
  16  * result.
  17  *
  18  * This interface is simplified version of {@link RuleBasedTransformer} - does not
  19  * provide decoupling of Acceptance rule from transformer, and should be used only
  20  * for simple use-cases.
  21  *
  22  * @author Tony Tkacik
  23  *
  24  * @param <I> Input class for transformation
  25  * @param <P> Product of transformation
  26  */
  27 public interface SimpleConditionalTransformer<I,P> extends Transformer<I, P>, Acceptor<I> {
  28
  29
  30     /**
  31      * Checks if the input is acceptable
  32      * for processing by the transformer.
  33      *
  34      * @return true it the input is acceptable for processing by transformer.
  35      */
  36     @Override
  37     public boolean isAcceptable(I input);
  38 }