Class BgpNeighborBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.BgpNeighborBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BgpNeighbor>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BgpNeighbor,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BgpNeighborBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BgpNeighbor>
Class that buildsBgpNeighborBuilder
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:
BgpNeighborBuilder createTarget(int fooXyzzy, int barBaz) { return new BgpNeighborBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpNeighborBuilder, 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:
BgpNeighborBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BgpNeighborBuilder()
BgpNeighborBuilder(BgpNeighbor base)
-
Method Summary
-
-
-
Constructor Detail
-
BgpNeighborBuilder
public BgpNeighborBuilder()
-
BgpNeighborBuilder
public BgpNeighborBuilder(BgpNeighbor base)
-
-
Method Detail
-
key
public BgpNeighborKey key()
-
getAfSpecificConfig
public AfSpecificConfig getAfSpecificConfig()
-
getAsNumber
public org.opendaylight.yangtools.yang.common.Uint32 getAsNumber()
-
getBgpNeighborState
public BgpNeighborState getBgpNeighborState()
-
getBgpNeighborStatistics
public BgpNeighborStatistics getBgpNeighborStatistics()
-
getDefaultAction
public ActionsEnum getDefaultAction()
-
getPeerAddressType
public PeerAddressType getPeerAddressType()
-
getPrefixList
public java.lang.String getPrefixList()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbor>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public BgpNeighborBuilder withKey(BgpNeighborKey key)
-
setAfSpecificConfig
public BgpNeighborBuilder setAfSpecificConfig(AfSpecificConfig value)
-
setAsNumber
public BgpNeighborBuilder setAsNumber(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setAsNumber
@Deprecated(forRemoval=true) public BgpNeighborBuilder setAsNumber(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAsNumber(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBgpNeighborState
public BgpNeighborBuilder setBgpNeighborState(BgpNeighborState value)
-
setBgpNeighborStatistics
public BgpNeighborBuilder setBgpNeighborStatistics(BgpNeighborStatistics value)
-
setDefaultAction
public BgpNeighborBuilder setDefaultAction(ActionsEnum value)
-
setPeerAddressType
public BgpNeighborBuilder setPeerAddressType(PeerAddressType value)
-
setPrefixList
public BgpNeighborBuilder setPrefixList(java.lang.String value)
-
addAugmentation
public BgpNeighborBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbor> 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 BgpNeighborBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpNeighbor>> 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 BgpNeighbor build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BgpNeighbor>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BgpNeighbor,java.lang.IllegalArgumentException>
-
-