Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.transport
Class StateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.transport.StateBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<State>
,org.opendaylight.yangtools.concepts.CheckedBuilder<State,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class StateBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<State>
Class that buildsStateBuilder
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:
StateBuilder createTarget(int fooXyzzy, int barBaz) { return new StateBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StateBuilder, 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:
StateBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description StateBuilder()
StateBuilder(State base)
StateBuilder(BgpNeighborTransportConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StateBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>>
E$$augmentation(Class<E$$> augmentationType)
State
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BgpNeighborTransportConfig.LocalAddress
getLocalAddress()
org.opendaylight.yangtools.yang.common.Uint16
getTcpMss()
Boolean
isMtuDiscovery()
Boolean
isPassiveMode()
StateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
StateBuilder
setLocalAddress(BgpNeighborTransportConfig.LocalAddress value)
StateBuilder
setMtuDiscovery(Boolean value)
StateBuilder
setPassiveMode(Boolean value)
StateBuilder
setTcpMss(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTcpMss(Uint16)} instead.StateBuilder
setTcpMss(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
StateBuilder
public StateBuilder()
-
StateBuilder
public StateBuilder(BgpNeighborTransportConfig arg)
-
StateBuilder
public StateBuilder(State 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.http.openconfig.net.yang.bgp.rev151009.BgpNeighborTransportConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getLocalAddress
public BgpNeighborTransportConfig.LocalAddress getLocalAddress()
-
getTcpMss
public org.opendaylight.yangtools.yang.common.Uint16 getTcpMss()
-
isMtuDiscovery
public Boolean isMtuDiscovery()
-
isPassiveMode
public Boolean isPassiveMode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> E$$ augmentation(Class<E$$> augmentationType)
-
setLocalAddress
public StateBuilder setLocalAddress(BgpNeighborTransportConfig.LocalAddress value)
-
setTcpMss
public StateBuilder setTcpMss(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setTcpMss
@Deprecated(forRemoval=true) public StateBuilder setTcpMss(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTcpMss(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMtuDiscovery
public StateBuilder setMtuDiscovery(Boolean value)
-
setPassiveMode
public StateBuilder setPassiveMode(Boolean value)
-
addAugmentation
public StateBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentationValue)
-
removeAugmentation
public StateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)
-
build
public State build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<State>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<State,IllegalArgumentException>
-
-