Class Ipv4Builder
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.ipv4._case.Ipv4Builder
Class that builds
Ipv4
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:
Ipv4 createIpv4(int fooXyzzy, int barBaz) {
return new Ipv4Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv4, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Ipv4Builder
(Ipv4 base) Construct a builder initialized with state from specifiedIpv4
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv4
build()
A newIpv4
instance.static @NonNull Ipv4
empty()
Get empty instance of Ipv4.Return current value associated with the property corresponding toIpv4.getIpv4ExtendedTunnelId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
Return current value associated with the property corresponding toIpv4.getIpv4TunnelEndpointAddress()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
Return current value associated with the property corresponding toIpv4.getIpv4TunnelSenderAddress()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toIpv4.getIpv4ExtendedTunnelId()
to the specified value.setIpv4TunnelEndpointAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toIpv4.getIpv4TunnelEndpointAddress()
to the specified value.setIpv4TunnelSenderAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toIpv4.getIpv4TunnelSenderAddress()
to the specified value.
-
Constructor Details
-
Ipv4Builder
public Ipv4Builder()Construct an empty builder. -
Ipv4Builder
Construct a builder initialized with state from specifiedIpv4
.- Parameters:
base
- Ipv4 from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Ipv4.- Returns:
- An empty
Ipv4
-
getIpv4ExtendedTunnelId
Return current value associated with the property corresponding toIpv4.getIpv4ExtendedTunnelId()
.- Returns:
- current value
-
getIpv4TunnelEndpointAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getIpv4TunnelEndpointAddress()Return current value associated with the property corresponding toIpv4.getIpv4TunnelEndpointAddress()
.- Returns:
- current value
-
getIpv4TunnelSenderAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getIpv4TunnelSenderAddress()Return current value associated with the property corresponding toIpv4.getIpv4TunnelSenderAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> 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
-
setIpv4ExtendedTunnelId
Set the property corresponding toIpv4.getIpv4ExtendedTunnelId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv4TunnelEndpointAddress
public Ipv4Builder setIpv4TunnelEndpointAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toIpv4.getIpv4TunnelEndpointAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv4TunnelSenderAddress
public Ipv4Builder setIpv4TunnelSenderAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toIpv4.getIpv4TunnelSenderAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> 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 Ipv4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> 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
A newIpv4
instance.- Returns:
- A new
Ipv4
instance.
-