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
  22 public interface DataObjectConverter {
  23
  24     <T extends DataObject> Optional<T> getDataObject(
  25             @Nonnull NormalizedNode normalizedNode,
  26             @Nonnull QName rootNode);
  27
  28     <T extends DataObject> Optional<T> getDataObjectFromRpc(
  29             @Nonnull NormalizedNode normalizedNode);
  30
  31     Optional<NormalizedNode> transformIntoNormalizedNode(
  32             @Nonnull InputStream inputStream);
  33
  34     Optional<NormalizedNode> transformIntoNormalizedNode(
  35             @Nonnull Reader inputReader, SchemaNode parentSchema);
  36
  37     Optional<NormalizedNode> transformIntoNormalizedNode(
  38             @Nonnull Reader inputReader);
  39
  40     <T extends DataObject> Writer writerFromDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
  41             ConvertType<T> convertType);
  42
  43     <T extends DataObject> Writer writerFromRpcDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
  44             ConvertType<T> convertType, QName rpcOutputQName, String rpcName);
  45
  46     <T extends DataObject> Optional<NormalizedNode> toNormalizedNodes(@Nonnull T object,
  47             Class dataObjectClass);
  48
  49     interface ConvertType<T> {
  50         Optional<NormalizedNode> toNormalizedNodes(T object, Class<T> clazz);
  51     }
  52
  53     /**
  54      * Returns a converter for {@link DataObject} container type.
  55      * @param <T> T extends DataObject
  56      *
  57      * @return {@link ConvertType} converter for {@link DataContainer}
  58      */
  59     <T extends DataObject> ConvertType<T> dataContainer();
  60
  61     /**
  62      * Returns converter for {@link DataContainer} rpc type.
  63      * @param <T> T extends DataContainer
  64      *
  65      * @return {@link ConvertType} converter for {@link DataContainer}
  66      *      representing rpc data
  67      */
  68     <T extends DataContainer> ConvertType<T> rpcData();
  69
  70     /**
  71      * Return converter for {@link Notification}.
  72      * @param <T> T extends Notification
  73      *
  74      * @return {@link ConvertType} converter for {@link Notification}
  75      */
  76     <T extends Notification> ConvertType<T> notification();
  77
  78 }