2 * Copyright © 2016 AT&T and others. All rights reserved.
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
8 package io.fd.honeycomb.transportpce.binding.converter.api;
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.YangInstanceIdentifier;
20 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
21 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
22 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
24 public interface DataObjectConverter {
26 <T extends DataObject> Optional<T> getDataObject(
27 @Nonnull NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?> normalizedNode,
28 @Nonnull QName rootNode);
30 <T extends DataObject> Optional<T> getDataObjectFromRpc(
31 @Nonnull NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?> normalizedNode,
32 @Nonnull SchemaPath rpcSchemaPath);
34 Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
35 @Nonnull InputStream inputStream);
37 Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
38 @Nonnull Reader inputReader, SchemaNode parentSchema);
40 Optional<NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?>> transformIntoNormalizedNode(
41 @Nonnull Reader inputReader);
43 <T extends DataObject> Writer writerFromDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
44 ConvertType<T> convertType);
46 <T extends DataObject> Writer writerFromRpcDataObject(@Nonnull DataObject object, Class<T> dataObjectClass,
47 ConvertType<T> convertType, QName rpcOutputQName, String rpcName);
49 <T extends DataObject> Optional<NormalizedNode<?, ?>> toNormalizedNodes(@Nonnull T object,
50 Class<T> dataObjectClass);
52 public interface ConvertType<T> {
53 Optional<NormalizedNode<?, ?>> toNormalizedNodes(T object, Class<T> clazz);
57 * Returns a converter for {@link DataObject} container type.
59 * @return {@link ConvertType} converter for {@link DataContainer}
61 <T extends DataObject> ConvertType<T> dataContainer();
64 * Returns converter for {@link DataContainer} rpc type.
66 * @return {@link ConvertType} converter for {@link DataContainer}
67 * representing rpc data
69 <T extends DataContainer> ConvertType<T> rpcData();
72 * Return converter for {@link Notification}.
74 * @return {@link ConvertType} converter for {@link Notification}
76 <T extends Notification> ConvertType<T> notification();