Class TransportBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.TransportBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Transport>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Transport,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TransportBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Transport>
Class that buildsTransportBuilder
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:
TransportBuilder createTarget(int fooXyzzy, int barBaz) { return new TransportBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TransportBuilder, 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:
TransportBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TransportBuilder()
TransportBuilder(Transport base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TransportBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Transport>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Transport> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Transport>>
E$$augmentation(Class<E$$> augmentationType)
Transport
build()
Config
getConfig()
State
getState()
TransportBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Transport>> augmentationType)
TransportBuilder
setConfig(Config value)
TransportBuilder
setState(State value)
-
-
-
Constructor Detail
-
TransportBuilder
public TransportBuilder()
-
TransportBuilder
public TransportBuilder(Transport base)
-
-
Method Detail
-
getConfig
public Config getConfig()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Transport>> E$$ augmentation(Class<E$$> augmentationType)
-
setConfig
public TransportBuilder setConfig(Config value)
-
setState
public TransportBuilder setState(State value)
-
addAugmentation
public TransportBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Transport>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Transport> augmentationValue)
-
removeAugmentation
public TransportBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Transport>> augmentationType)
-
build
public Transport build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Transport>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Transport,IllegalArgumentException>
-
-