Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206
Class NetconfConfirmedCommitBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfConfirmedCommitBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NetconfConfirmedCommit>,org.opendaylight.yangtools.concepts.CheckedBuilder<NetconfConfirmedCommit,IllegalArgumentException>,org.opendaylight.yangtools.concepts.Mutable,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NetconfConfirmedCommitBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NetconfConfirmedCommit>
Class that buildsNetconfConfirmedCommitBuilderinstances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
NetconfConfirmedCommitBuilder createTarget(int fooXyzzy, int barBaz) { return new NetconfConfirmedCommitBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of NetconfConfirmedCommitBuilder, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build(), which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization oportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
NetconfConfirmedCommitBuilder,Builder
-
-
Constructor Summary
Constructors Constructor Description NetconfConfirmedCommitBuilder()NetconfConfirmedCommitBuilder(CommonSessionParms arg)NetconfConfirmedCommitBuilder(NetconfConfirmedCommit base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NetconfConfirmedCommitBuilderaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetconfConfirmedCommit> augmentation)Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetconfConfirmedCommit>>
E$$augmentation(Class<E$$> augmentationType)NetconfConfirmedCommitbuild()voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.NetconfConfirmedCommit.ConfirmEventgetConfirmEvent()org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdOrZeroTypegetSessionId()org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressgetSourceHost()org.opendaylight.yangtools.yang.common.Uint32getTimeout()StringgetUsername()NetconfConfirmedCommitBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetconfConfirmedCommit>> augmentationType)Remove an augmentation from this builder's product.NetconfConfirmedCommitBuildersetConfirmEvent(NetconfConfirmedCommit.ConfirmEvent value)NetconfConfirmedCommitBuildersetSessionId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdOrZeroType value)NetconfConfirmedCommitBuildersetSourceHost(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)NetconfConfirmedCommitBuildersetTimeout(Long value)Deprecated, for removal: This API element is subject to removal in a future version.UsesetTimeout(Uint32)instead.NetconfConfirmedCommitBuildersetTimeout(org.opendaylight.yangtools.yang.common.Uint32 value)NetconfConfirmedCommitBuildersetUsername(String value)
-
-
-
Constructor Detail
-
NetconfConfirmedCommitBuilder
public NetconfConfirmedCommitBuilder()
-
NetconfConfirmedCommitBuilder
public NetconfConfirmedCommitBuilder(CommonSessionParms arg)
-
NetconfConfirmedCommitBuilder
public NetconfConfirmedCommitBuilder(NetconfConfirmedCommit base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.CommonSessionParms
- Parameters:
arg- grouping object- Throws:
IllegalArgumentException- if given argument is none of valid types or has property with incompatible value
-
getConfirmEvent
public NetconfConfirmedCommit.ConfirmEvent getConfirmEvent()
-
getSessionId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdOrZeroType getSessionId()
-
getSourceHost
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getSourceHost()
-
getTimeout
public org.opendaylight.yangtools.yang.common.Uint32 getTimeout()
-
getUsername
public String getUsername()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NetconfConfirmedCommit>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfirmEvent
public NetconfConfirmedCommitBuilder setConfirmEvent(NetconfConfirmedCommit.ConfirmEvent value)
-
setSessionId
public NetconfConfirmedCommitBuilder setSessionId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdOrZeroType value)
-
setSourceHost
public NetconfConfirmedCommitBuilder setSourceHost(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setTimeout
public NetconfConfirmedCommitBuilder setTimeout(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setTimeout
@Deprecated(forRemoval=true) public NetconfConfirmedCommitBuilder setTimeout(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTimeout(Uint32)instead.Utility migration setter.- Parameters:
value- field value in legacy type- Returns:
- this builder
-
setUsername
public NetconfConfirmedCommitBuilder setUsername(String value)
-
addAugmentation
public NetconfConfirmedCommitBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NetconfConfirmedCommit> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public NetconfConfirmedCommitBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NetconfConfirmedCommit>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType- augmentation type to be removed- Returns:
- this builder
-
build
public NetconfConfirmedCommit build()
- Specified by:
buildin interfaceorg.opendaylight.yangtools.concepts.Builder<NetconfConfirmedCommit>- Specified by:
buildin interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NetconfConfirmedCommit,IllegalArgumentException>
-
-