data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/StreamWriterMetadataExtension.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech, s.r.o. 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.yang.data.api.schema.stream;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ImmutableMap;
  12 import java.io.IOException;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14
  15 /**
  16  * Extension to the NormalizedNodeStreamWriter with metadata support. Semantically this extends the event model of
  17  * {@link NormalizedNodeStreamWriter} with a new event, {@link #metadata(ImmutableMap)}. This event is valid on any
  18  * open node. This event may be emitted only once.
  19  *
  20  * <p>
  21  * Note that some implementations of this interface, notably those targeting streaming XML, may require metadata to
  22  * be emitted before any other events. Such requirement is communicated through {@link #requireMetadataFirst()} and
  23  * users must honor it. If such requirement is not set, metadata may be emitted at any time.
  24  *
  25  * <p>
  26  * Furthermore implementations targeting RFC7952 encoding towards external systems are required to handle metadata
  27  * attached to {@code leaf-list} and {@code list} nodes by correctly extending them to each entry.
  28  */
  29 @Beta
  30 public interface StreamWriterMetadataExtension extends NormalizedNodeStreamWriterExtension {
  31     /**
  32      * Emit a block of metadata associated with the currently-open node. The argument is a map of annotation names,
  33      * as defined {@code md:annotation} extension. Values are normalized objects, which are required to be
  34      * effectively-immutable.
  35      *
  36      * @param metadata Metadata block
  37      * @throws NullPointerException if {@code metadata} is null
  38      * @throws IllegalStateException when this method is invoked outside of an open node or metadata has already been
  39      *                               emitted.
  40      * @throws IOException if an underlying IO error occurs
  41      */
  42     void metadata(ImmutableMap<QName, Object> metadata) throws IOException;
  43
  44     /**
  45      * Indicate whether metadata is required to be emitted just after an entry is open. The default implementation
  46      * returns false.
  47      *
  48      * @return True if metadata must occur just after the start of an entry.
  49      */
  50     default boolean requireMetadataFirst() {
  51         return false;
  52     }
  53 }