Class Ipv4CaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.te.lsp._case.address.family.Ipv4CaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4Case>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Case,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv4CaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4Case>
Class that buildsIpv4Case
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:
Ipv4Case createIpv4Case(int fooXyzzy, int barBaz) { return new Ipv4CaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4Case, 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:
Ipv4Case
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4CaseBuilder()
Ipv4CaseBuilder(Ipv4Case base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv4CaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case>>
E$$augmentation(Class<E$$> augmentationType)
Ipv4Case
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getIpv4TunnelEndpointAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getIpv4TunnelSenderAddress()
Ipv4CaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case>> augmentationType)
Remove an augmentation from this builder's product.Ipv4CaseBuilder
setIpv4TunnelEndpointAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
Ipv4CaseBuilder
setIpv4TunnelSenderAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
-
-
Constructor Detail
-
Ipv4CaseBuilder
public Ipv4CaseBuilder()
-
Ipv4CaseBuilder
public Ipv4CaseBuilder(Ipv4Case base)
-
-
Method Detail
-
getIpv4TunnelEndpointAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getIpv4TunnelEndpointAddress()
-
getIpv4TunnelSenderAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getIpv4TunnelSenderAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpv4TunnelEndpointAddress
public Ipv4CaseBuilder setIpv4TunnelEndpointAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setIpv4TunnelSenderAddress
public Ipv4CaseBuilder setIpv4TunnelSenderAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
addAugmentation
public Ipv4CaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case> 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 Ipv4CaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case>> 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 Ipv4Case build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv4Case>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Case,IllegalArgumentException>
-
-