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

   1 /*
   2  * Copyright (c) 2015 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.yang.data.api.schema.stream;
   9
  10 import com.google.common.annotations.Beta;
  11 import javax.annotation.Nonnull;
  12 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  13
  14 /**
  15  * Mixin interface for {@link NormalizedNodeStreamWriter} allowing callers to inform the writer of the
  16  * {@link DataSchemaNode} corresponding to the next node which will either be started or emitted. This interface should
  17  * not be implemented directly.
  18  */
  19 @Beta
  20 public interface DataSchemaNodeAware {
  21     /**
  22      * Attach the specified {@link DataSchemaNode} to the next node which will get started or emitted.
  23      *
  24      * @param schema DataSchemaNode
  25      * @throws NullPointerException if the argument is null
  26      */
  27     void nextDataSchemaNode(@Nonnull DataSchemaNode schema);
  28 }