Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match
Class Ipv6MatchArbitraryBitMaskBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv6MatchArbitraryBitMaskBuilder
Class that builds
Ipv6MatchArbitraryBitMask
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:
Ipv6MatchArbitraryBitMask createIpv6MatchArbitraryBitMask(int fooXyzzy, int barBaz) {
return new Ipv6MatchArbitraryBitMaskBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv6MatchArbitraryBitMask, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedIpv6MatchArbitraryBitMask
.Construct a new builder initialized from specifiedIpv6MatchArbitraryBitmaskFields
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6MatchArbitraryBitMask> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6MatchArbitraryBitMask>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv6MatchArbitraryBitMask
build()
A newIpv6MatchArbitraryBitMask
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationAddressNoMask()
.Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationArbitraryBitmask()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceAddressNoMask()
.Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceArbitraryBitmask()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6MatchArbitraryBitMask>> augmentationType) Remove an augmentation from this builder's product.setIpv6DestinationAddressNoMask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value) Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationAddressNoMask()
to the specified value.Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationArbitraryBitmask()
to the specified value.setIpv6SourceAddressNoMask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value) Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceAddressNoMask()
to the specified value.Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceArbitraryBitmask()
to the specified value.
-
Constructor Details
-
Ipv6MatchArbitraryBitMaskBuilder
public Ipv6MatchArbitraryBitMaskBuilder()Construct an empty builder. -
Ipv6MatchArbitraryBitMaskBuilder
Construct a new builder initialized from specifiedIpv6MatchArbitraryBitmaskFields
.- Parameters:
arg
- Ipv6MatchArbitraryBitmaskFields from which the builder should be initialized
-
Ipv6MatchArbitraryBitMaskBuilder
Construct a builder initialized with state from specifiedIpv6MatchArbitraryBitMask
.- Parameters:
base
- Ipv6MatchArbitraryBitMask from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIpv6DestinationAddressNoMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6DestinationAddressNoMask()Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationAddressNoMask()
.- Returns:
- current value
-
getIpv6DestinationArbitraryBitmask
Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationArbitraryBitmask()
.- Returns:
- current value
-
getIpv6SourceAddressNoMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6SourceAddressNoMask()Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceAddressNoMask()
.- Returns:
- current value
-
getIpv6SourceArbitraryBitmask
Return current value associated with the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceArbitraryBitmask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6MatchArbitraryBitMask>> 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
-
setIpv6DestinationAddressNoMask
public Ipv6MatchArbitraryBitMaskBuilder setIpv6DestinationAddressNoMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value) Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationAddressNoMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6DestinationArbitraryBitmask
Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6DestinationArbitraryBitmask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6SourceAddressNoMask
public Ipv6MatchArbitraryBitMaskBuilder setIpv6SourceAddressNoMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value) Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceAddressNoMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6SourceArbitraryBitmask
Set the property corresponding toIpv6MatchArbitraryBitmaskFields.getIpv6SourceArbitraryBitmask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6MatchArbitraryBitMaskBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6MatchArbitraryBitMask> 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 Ipv6MatchArbitraryBitMaskBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6MatchArbitraryBitMask>> 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 newIpv6MatchArbitraryBitMask
instance.- Returns:
- A new
Ipv6MatchArbitraryBitMask
instance.
-