Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor
Class BgpNeighborStateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.BgpNeighborStateBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpNeighborState>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpNeighborState,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BgpNeighborStateBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BgpNeighborState>
Class that buildsBgpNeighborStateBuilder
instances. 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:
BgpNeighborStateBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpNeighborStateBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpNeighborStateBuilder, 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:
BgpNeighborStateBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpNeighborStateBuilder()
BgpNeighborStateBuilder(BgpNeighborState base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BgpNeighborStateBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighborState> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighborState>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BgpNeighborState
build()
BgpPeerAdminStatus
getAdminStatus()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp
getInLastupdatetime()
BgpNeighborStateBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighborState>> augmentationType)
Remove an augmentation from this builder's product.BgpNeighborStateBuilder
setAdminStatus(BgpPeerAdminStatus value)
BgpNeighborStateBuilder
setInLastupdatetime(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
-
-
-
Constructor Detail
-
BgpNeighborStateBuilder
public BgpNeighborStateBuilder()
-
BgpNeighborStateBuilder
public BgpNeighborStateBuilder(BgpNeighborState base)
-
-
Method Detail
-
getAdminStatus
public BgpPeerAdminStatus getAdminStatus()
-
getInLastupdatetime
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp getInLastupdatetime()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighborState>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setAdminStatus
public BgpNeighborStateBuilder setAdminStatus(BgpPeerAdminStatus value)
-
setInLastupdatetime
public BgpNeighborStateBuilder setInLastupdatetime(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timestamp value)
-
addAugmentation
public BgpNeighborStateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighborState> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public BgpNeighborStateBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighborState>> 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 BgpNeighborState build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BgpNeighborState>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BgpNeighborState,java.lang.IllegalArgumentException>
-
-