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