code-generator/binding-data-codec/src/main/java/org/opendaylight/yangtools/binding/data/codec/api/BindingNormalizedNodeWriterFactory.java

   1 /*
   2  * Copyright (c) 2014 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.binding.data.codec.api;
   9
  10 import java.util.Map.Entry;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
  13 import org.opendaylight.yangtools.yang.binding.DataContainer;
  14 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  15 import org.opendaylight.yangtools.yang.binding.Notification;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  18
  19 /**
  20  *
  21  * Factory for {@link BindingStreamEventWriter}, which provides stream writers
  22  * which translates data and delegates calls to
  23  * {@link NormalizedNodeStreamWriter}.
  24  *
  25  */
  26 public interface BindingNormalizedNodeWriterFactory {
  27
  28     /**
  29      *
  30      * Creates a {@link BindingStreamEventWriter} for data tree path which will
  31      * translate to NormalizedNode model and invoke proper events on supplied
  32      * {@link NormalizedNodeStreamWriter}.
  33      * <p>
  34      * Also provides translation of supplied Instance Identifier to
  35      * {@link YangInstanceIdentifier} so client code, does not need to translate
  36      * that separately.
  37      * <p>
  38      * If {@link YangInstanceIdentifier} is not needed, please use
  39      * {@link #newWriter(InstanceIdentifier, NormalizedNodeStreamWriter)}
  40      * method to conserve resources.
  41      *
  42      * @param path
  43      *            Binding Path in conceptual data tree, for which writer should
  44      *            be instantiated
  45      * @param domWriter
  46      *            Stream writer on which events will be invoked.
  47      * @return Instance Identifier and {@link BindingStreamEventWriter}
  48      *         which will write to supplied {@link NormalizedNodeStreamWriter}.
  49      */
  50     @Nonnull Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(@Nonnull InstanceIdentifier<?> path,
  51             @Nonnull NormalizedNodeStreamWriter domWriter);
  52
  53     /**
  54      *
  55      * Creates a {@link BindingStreamEventWriter} for data tree path which will
  56      * translate to NormalizedNode model and invoke proper events on supplied
  57      * {@link NormalizedNodeStreamWriter}.
  58      * <p>
  59      *
  60      * This variation does not provide YANG instance identifier and is useful
  61      * for use-cases, where {@link InstanceIdentifier} translation is done
  62      * in other way, or YANG instance identifier is unnecessary (e.g. notifications, RPCs).
  63      *
  64      * @param path Binding Path in conceptual data tree, for which writer should
  65      *            be instantiated
  66      * @param domWriter Stream writer on which events will be invoked.
  67      * @return {@link BindingStreamEventWriter}
  68      *         which will write to supplied {@link NormalizedNodeStreamWriter}.
  69      */
  70     @Nonnull
  71     BindingStreamEventWriter newWriter(@Nonnull InstanceIdentifier<?> path,
  72             @Nonnull NormalizedNodeStreamWriter domWriter);
  73
  74     /**
  75      *
  76      * Creates a {@link BindingStreamEventWriter} for rpc data which will
  77      * translate to NormalizedNode model and invoke proper events on supplied
  78      * {@link NormalizedNodeStreamWriter}.
  79      *
  80      * @param rpcInputOrOutput Binding class representing RPC input or output,
  81      *            for which writer should be instantiated
  82      * @param domWriter
  83      *            Stream writer on which events will be invoked.
  84      * @return {@link BindingStreamEventWriter} which will write to supplied
  85      *         {@link NormalizedNodeStreamWriter}.
  86      */
  87     @Nonnull
  88     BindingStreamEventWriter newRpcWriter(@Nonnull Class<? extends DataContainer> rpcInputOrOutput,
  89             @Nonnull NormalizedNodeStreamWriter domWriter);
  90
  91     /**
  92      *
  93      * Creates a {@link BindingStreamEventWriter} for notification which will
  94      * translate to NormalizedNode model and invoke proper events on supplied
  95      * {@link NormalizedNodeStreamWriter}.
  96      *
  97      * @param notification Binding class representing notification,
  98      *            for which writer should be instantiated
  99      * @param domWriter
 100      *            Stream writer on which events will be invoked.
 101      * @return {@link BindingStreamEventWriter} which will write to supplied
 102      *         {@link NormalizedNodeStreamWriter}.
 103      */
 104     @Nonnull
 105     BindingStreamEventWriter newNotificationWriter(@Nonnull Class<? extends Notification> notification,
 106             @Nonnull NormalizedNodeStreamWriter domWriter);
 107 }