Class Ipv6Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.identifiers.tlv.lsp.identifiers.address.family.ipv6._case.Ipv6Builder
-
@Generated("mdsal-binding-generator") public class Ipv6Builder extends Object
Class that buildsIpv6
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:
Ipv6 createIpv6(int fooXyzzy, int barBaz) { return new Ipv6Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6, 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:
Ipv6
- 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
-
-
Constructor Summary
Constructors Constructor Description Ipv6Builder()
Construct an empty builder.Ipv6Builder(Ipv6 base)
Construct a builder initialized with state from specifiedIpv6
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv6
build()
A newIpv6
instance.Ipv6ExtendedTunnelId
getIpv6ExtendedTunnelId()
Return current value associated with the property corresponding toIpv6.getIpv6ExtendedTunnelId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone
getIpv6TunnelEndpointAddress()
Return current value associated with the property corresponding toIpv6.getIpv6TunnelEndpointAddress()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone
getIpv6TunnelSenderAddress()
Return current value associated with the property corresponding toIpv6.getIpv6TunnelSenderAddress()
.Ipv6Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> augmentationType)
Remove an augmentation from this builder's product.Ipv6Builder
setIpv6ExtendedTunnelId(Ipv6ExtendedTunnelId value)
Set the property corresponding toIpv6.getIpv6ExtendedTunnelId()
to the specified value.Ipv6Builder
setIpv6TunnelEndpointAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
Set the property corresponding toIpv6.getIpv6TunnelEndpointAddress()
to the specified value.Ipv6Builder
setIpv6TunnelSenderAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
Set the property corresponding toIpv6.getIpv6TunnelSenderAddress()
to the specified value.
-
-
-
Method Detail
-
getIpv6ExtendedTunnelId
public Ipv6ExtendedTunnelId getIpv6ExtendedTunnelId()
Return current value associated with the property corresponding toIpv6.getIpv6ExtendedTunnelId()
.- Returns:
- current value
-
getIpv6TunnelEndpointAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getIpv6TunnelEndpointAddress()
Return current value associated with the property corresponding toIpv6.getIpv6TunnelEndpointAddress()
.- Returns:
- current value
-
getIpv6TunnelSenderAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getIpv6TunnelSenderAddress()
Return current value associated with the property corresponding toIpv6.getIpv6TunnelSenderAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setIpv6ExtendedTunnelId
public Ipv6Builder setIpv6ExtendedTunnelId(Ipv6ExtendedTunnelId value)
Set the property corresponding toIpv6.getIpv6ExtendedTunnelId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6TunnelEndpointAddress
public Ipv6Builder setIpv6TunnelEndpointAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
Set the property corresponding toIpv6.getIpv6TunnelEndpointAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6TunnelSenderAddress
public Ipv6Builder setIpv6TunnelSenderAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
Set the property corresponding toIpv6.getIpv6TunnelSenderAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6> 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 Ipv6Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> 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
-
-