Package com.tailf.maapi

Class DryRunResult

Object

com.tailf.maapi.ApplyResult

com.tailf.maapi.DryRunResult

All Implemented Interfaces:

Iterable<DryRunResult.DryRunEntry>

public class DryRunResult
extends ApplyResult
implements Iterable<DryRunResult.DryRunEntry>

Represents a successful invocation of the Maapi.applyTransParams(int, boolean, CommitParams) method.

The purpose of this class is to represent the result of a transaction without actually having committed the changes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DryRunResult.DryRunEntry
static enum	DryRunResult.Format

Constructor Summary

Constructors

Constructor	Description
DryRunResult(ConfResponse result)

Method Summary

Modifier and Type	Method	Description
DryRunResult.Format	getFormat()	Return the format of the dry-run result.
String	getFormatAsString()	Return the format as a string.
Iterator<DryRunResult.DryRunEntry>	iterator()	Retrieves an iterator from which one could iterate over the result.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

DryRunResult

public DryRunResult(ConfResponse result)
             throws MaapiException,
ConfException

Throws:

MaapiException

ConfException

Method Details

getFormat

public DryRunResult.Format getFormat()

Return the format of the dry-run result.

The format could be any of the following:

DryRunResult.Format.XML means that all changes in the whole data model is displayed in NETCONF XML edit-config format, i.e., the edit-config that would be applied locally (at NCS) to get a config that is equal to that of the managed device.

DryRunResult.Format.CLI means that all changes in the whole data model is displayed in NCS CLI curly bracket format.

DryRunResult.Format.CLI_C means that all changes in the whole data model is displayed in Cisco style CLI format.

DryRunResult.Format.NATIVE means that only changes under /devices/device/config is displayed in native device format.

getFormatAsString

public String getFormatAsString()

Return the format as a string.

iterator

public Iterator<DryRunResult.DryRunEntry> iterator()

Retrieves an iterator from which one could iterate over the result.

Specified by:

iterator in interface Iterable<DryRunResult.DryRunEntry>