Class Ipv6SrcBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ipv6.src._case.Ipv6SrcBuilder
Class that builds
Ipv6Src
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:
Ipv6Src createIpv6Src(int fooXyzzy, int barBaz) {
return new Ipv6SrcBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv6Src, 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.Ipv6SrcBuilder
(Ipv6Src base) Construct a builder initialized with state from specifiedIpv6Src
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Src
build()
A newIpv6Src
instance.static @NonNull Ipv6Src
empty()
Get empty instance of Ipv6Src.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
Return current value associated with the property corresponding toIpv6Src.getIpv6Address()
.byte[]
getMask()
Return current value associated with the property corresponding toIpv6Src.getMask()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src>> augmentationType) Remove an augmentation from this builder's product.setIpv6Address
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value) Set the property corresponding toIpv6Src.getIpv6Address()
to the specified value.setMask
(byte[] value) Set the property corresponding toIpv6Src.getMask()
to the specified value.
-
Constructor Details
-
Ipv6SrcBuilder
public Ipv6SrcBuilder()Construct an empty builder. -
Ipv6SrcBuilder
Construct a builder initialized with state from specifiedIpv6Src
.- Parameters:
base
- Ipv6Src from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Ipv6Src.- Returns:
- An empty
Ipv6Src
-
getIpv6Address
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6Address()Return current value associated with the property corresponding toIpv6Src.getIpv6Address()
.- Returns:
- current value
-
getMask
public byte[] getMask()Return current value associated with the property corresponding toIpv6Src.getMask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src>> 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
-
setIpv6Address
public Ipv6SrcBuilder setIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value) Set the property corresponding toIpv6Src.getIpv6Address()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMask
Set the property corresponding toIpv6Src.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6SrcBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src> 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 Ipv6SrcBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Src>> 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 newIpv6Src
instance.- Returns:
- A new
Ipv6Src
instance.
-