Class Ipv4NextHopCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.next.hop.c.next.hop.Ipv4NextHopCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4NextHopCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4NextHopCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv4NextHopCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4NextHopCase>
Class that buildsIpv4NextHopCase
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:
Ipv4NextHopCase createIpv4NextHopCase(int fooXyzzy, int barBaz) { return new Ipv4NextHopCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4NextHopCase, 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 opportunities, 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:
Ipv4NextHopCase
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4NextHopCaseBuilder()
Ipv4NextHopCaseBuilder(Ipv4NextHopCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv4NextHopCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4NextHopCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4NextHopCase>>
E$$augmentation(Class<E$$> augmentationType)
Ipv4NextHopCase
build()
Ipv4NextHop
getIpv4NextHop()
Ipv4NextHopCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4NextHopCase>> augmentationType)
Remove an augmentation from this builder's product.Ipv4NextHopCaseBuilder
setIpv4NextHop(Ipv4NextHop value)
-
-
-
Constructor Detail
-
Ipv4NextHopCaseBuilder
public Ipv4NextHopCaseBuilder()
-
Ipv4NextHopCaseBuilder
public Ipv4NextHopCaseBuilder(Ipv4NextHopCase base)
-
-
Method Detail
-
getIpv4NextHop
public Ipv4NextHop getIpv4NextHop()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4NextHopCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpv4NextHop
public Ipv4NextHopCaseBuilder setIpv4NextHop(Ipv4NextHop value)
-
addAugmentation
public Ipv4NextHopCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4NextHopCase> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public Ipv4NextHopCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4NextHopCase>> 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 Ipv4NextHopCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv4NextHopCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4NextHopCase,IllegalArgumentException>
-
-