Deprecate ClassBasedPropertyBuilder

[yangtools.git] / common / concepts / src / main / java / org / opendaylight / yangtools / concepts / Serializer.java

diff --git a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Serializer.java b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Serializer.java
index 81c03addaa0725b61b6315126db87a60d6bdb136..f7a85c00a9222e7d2d0422d93ea630ae94eea836 100644 (file)
--- a/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Serializer.java
+++ b/common/concepts/src/main/java/org/opendaylight/yangtools/concepts/Serializer.java
@@ -9,7 +9,21 @@ package org.opendaylight.yangtools.concepts;
 
 import org.eclipse.jdt.annotation.NonNull;
 
-// FIXME: 4.0.0: we need error reporting, is this class even useful?
-public interface Serializer<P, I> {
-    @NonNull P serialize(@NonNull I input);
+/**
+ * An entity which is able to convert some input into a product.
+ *
+ * @param <P> Product type
+ * @param <I> Input type
+ * @param <X> Error exception type
+ */
+public interface Serializer<P, I, X extends Exception> {
+    /**
+     * Convert an input into a product.
+     *
+     * @param input Input
+     * @return A product
+     * @throws NullPointerException if input is null
+     * @throws X when input is not valid
+     */
+    @NonNull P serialize(@NonNull I input) throws X;
 }