Module org.opendaylight.yangtools.rfc8528.data.api

Package org.opendaylight.yangtools.rfc8528.data.api

Interface StreamWriterMountPointExtension

All Superinterfaces:

org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriterExtension, ObjectExtension<org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter,org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriterExtension>

@Beta
@NonNullByDefault
public interface StreamWriterMountPointExtension
extends org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriterExtension

A NormalizedNodeStreamWriterExtension exposed by stream writers which can handle mount point data, notably providing the facilities to resolve a mount point schema and normalize mount point contents into a normalized structure.

Method Summary

Modifier and Type	Method	Description
org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter	startMountPoint(MountPointIdentifier mountId, MountPointContext mountCtx)	Start a new mount point with a specific mount point context.

Method Details

startMountPoint

org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter startMountPoint(MountPointIdentifier mountId,
 MountPointContext mountCtx)
                                                                                           throws IOException

Start a new mount point with a specific mount point context. The returned writer will be used to emit the content of the mount point, without touching the writer to which this extension is attached to. Once that is done, the returned writer will be NormalizedNodeStreamWriter.close()d, at which point the parent writer will be used again to emit the rest of the tree.

Parameters:

mountId - Mount point identifier

mountCtx - Mount point context

Returns:

A new NormalizedNodeStreamWriter

Throws:

IOException - if an error occurs