test-common/src/main/java/org/opendaylight/transportpce/test/converter/DataObjectConverter.java

   1 /*
   2  * Copyright © 2016 AT&T 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.transportpce.test.converter;
   9
  10 import java.io.InputStream;
  11 import java.io.Reader;
  12 import java.io.Writer;
  13 import java.util.Optional;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.yangtools.yang.binding.DataContainer;
  16 import org.opendaylight.yangtools.yang.binding.DataObject;
  17 import org.opendaylight.yangtools.yang.binding.Notification;
  18 import org.opendaylight.yangtools.yang.common.QName;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  22
  23 public interface DataObjectConverter {
  24
  25     <T extends DataObject> Optional<T> getDataObject(
  26             @Nonnull NormalizedNode normalizedNode,
  27             @Nonnull QName rootNode);
  28
  29     <T extends DataObject> Optional<T> getDataObjectFromRpc(
  30             @Nonnull NormalizedNode normalizedNode,
  31             @Nonnull SchemaPath rpcSchemaPath);
  32
  33     Optional<NormalizedNode> transformIntoNormalizedNode(
  34             @Nonnull InputStream inputStream);
  35
  36     Optional<NormalizedNode> transformIntoNormalizedNode(
  37             @Nonnull Reader inputReader, SchemaNode parentSchema);
  38
  39     Optional<NormalizedNode> transformIntoNormalizedNode(
  40             @Nonnull Reader inputReader);
  41
  42     <T extends DataObject> Writer writerFromDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
  43             ConvertType<T> convertType);
  44
  45     <T extends DataObject> Writer writerFromRpcDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
  46             ConvertType<T> convertType, QName rpcOutputQName, String rpcName);
  47
  48     <T extends DataObject> Optional<NormalizedNode> toNormalizedNodes(@Nonnull T object,
  49             Class<T> dataObjectClass);
  50
  51     public interface ConvertType<T> {
  52         Optional<NormalizedNode> toNormalizedNodes(T object, Class<T> clazz);
  53     }
  54
  55     /**
  56      * Returns a converter for {@link DataObject} container type.
  57      * @param <T> T extends DataObject
  58      *
  59      * @return {@link ConvertType} converter for {@link DataContainer}
  60      */
  61     <T extends DataObject> ConvertType<T> dataContainer();
  62
  63     /**
  64      * Returns converter for {@link DataContainer} rpc type.
  65      * @param <T> T extends DataContainer
  66      *
  67      * @return {@link ConvertType} converter for {@link DataContainer}
  68      *      representing rpc data
  69      */
  70     <T extends DataContainer> ConvertType<T> rpcData();
  71
  72     /**
  73      * Return converter for {@link Notification}.
  74      * @param <T> T extends Notification
  75      *
  76      * @return {@link ConvertType} converter for {@link Notification}
  77      */
  78     <T extends Notification> ConvertType<T> notification();
  79
  80 }