data/rfc8528-data-api/src/main/java/org/opendaylight/yangtools/rfc8528/data/api/MountPointChild.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.rfc8528.data.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.io.IOException;
  12 import org.eclipse.jdt.annotation.NonNullByDefault;
  13 import org.opendaylight.yangtools.yang.data.api.schema.NormalizableAnydata;
  14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  15 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  16 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  17
  18 /**
  19  * An unresolved child within a mount point. This is similar in functionality to {@link NormalizableAnydata}, but
  20  * rather than normalizing, the data is fed into a combination of a EffectiveModelContext and
  21  * NormalizedNodeStreamWriter.
  22  */
  23 @Beta
  24 @NonNullByDefault
  25 public interface MountPointChild {
  26     /**
  27      * Stream this child into a writer, with the help of a SchemaContext.
  28      *
  29      * @param writer Writer to emit the child into
  30      * @param mountCtx MountPointContext for normalization purposes
  31      * @throws IOException if an underlying error occurs
  32      * @throws NullPointerException if any of the arguments is null
  33      */
  34     void writeTo(NormalizedNodeStreamWriter writer, MountPointContext mountCtx) throws IOException;
  35
  36     /**
  37      * Normalized this child to a particular EffectiveModelContext.
  38      *
  39      * @param schemaContext SchemaContext for normalization purposes
  40      * @return A NormalizedNode representation of this child
  41      * @throws IOException if an underlying error occurs
  42      * @throws NullPointerException if any of the arguments is null
  43      */
  44     NormalizedNode normalizeTo(EffectiveModelContext schemaContext) throws IOException;
  45 }