common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Serializer.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 package org.opendaylight.yangtools.concepts;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11
  12 /**
  13  * An entity which is able to convert some input into a product.
  14  *
  15  * @param <P> Product type
  16  * @param <I> Input type
  17  * @param <X> Error exception type
  18  */
  19 public interface Serializer<P, I, X extends Exception> {
  20     /**
  21      * Convert an input into a product.
  22      *
  23      * @param input Input
  24      * @return A product
  25      * @throws NullPointerException if input is null
  26      * @throws X when input is not valid
  27      */
  28     @NonNull P serialize(@NonNull I input) throws X;
  29 }