Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match
Class Ipv4MatchArbitraryBitMaskBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchArbitraryBitMaskBuilder
Class that builds
Ipv4MatchArbitraryBitMask
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:
Ipv4MatchArbitraryBitMask createIpv4MatchArbitraryBitMask(int fooXyzzy, int barBaz) {
return new Ipv4MatchArbitraryBitMaskBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv4MatchArbitraryBitMask, 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 new builder initialized from specifiedIpv4MatchArbitraryBitmaskFields
.Construct a builder initialized with state from specifiedIpv4MatchArbitraryBitMask
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4MatchArbitraryBitMask> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4MatchArbitraryBitMask>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv4MatchArbitraryBitMask
build()
A newIpv4MatchArbitraryBitMask
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.Ipv4Address
Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationAddressNoMask()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad
Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationArbitraryBitmask()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceAddressNoMask()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad
Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceArbitraryBitmask()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4MatchArbitraryBitMask>> augmentationType) Remove an augmentation from this builder's product.setIpv4DestinationAddressNoMask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationAddressNoMask()
to the specified value.setIpv4DestinationArbitraryBitmask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationArbitraryBitmask()
to the specified value.setIpv4SourceAddressNoMask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceAddressNoMask()
to the specified value.setIpv4SourceArbitraryBitmask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceArbitraryBitmask()
to the specified value.
-
Constructor Details
-
Ipv4MatchArbitraryBitMaskBuilder
public Ipv4MatchArbitraryBitMaskBuilder()Construct an empty builder. -
Ipv4MatchArbitraryBitMaskBuilder
Construct a new builder initialized from specifiedIpv4MatchArbitraryBitmaskFields
.- Parameters:
arg
- Ipv4MatchArbitraryBitmaskFields from which the builder should be initialized
-
Ipv4MatchArbitraryBitMaskBuilder
Construct a builder initialized with state from specifiedIpv4MatchArbitraryBitMask
.- Parameters:
base
- Ipv4MatchArbitraryBitMask 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
-
getIpv4DestinationAddressNoMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4DestinationAddressNoMask()Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationAddressNoMask()
.- Returns:
- current value
-
getIpv4DestinationArbitraryBitmask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad getIpv4DestinationArbitraryBitmask()Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationArbitraryBitmask()
.- Returns:
- current value
-
getIpv4SourceAddressNoMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4SourceAddressNoMask()Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceAddressNoMask()
.- Returns:
- current value
-
getIpv4SourceArbitraryBitmask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad getIpv4SourceArbitraryBitmask()Return current value associated with the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceArbitraryBitmask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4MatchArbitraryBitMask>> 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
-
setIpv4DestinationAddressNoMask
public Ipv4MatchArbitraryBitMaskBuilder setIpv4DestinationAddressNoMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationAddressNoMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv4DestinationArbitraryBitmask
public Ipv4MatchArbitraryBitMaskBuilder setIpv4DestinationArbitraryBitmask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4DestinationArbitraryBitmask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv4SourceAddressNoMask
public Ipv4MatchArbitraryBitMaskBuilder setIpv4SourceAddressNoMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceAddressNoMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv4SourceArbitraryBitmask
public Ipv4MatchArbitraryBitMaskBuilder setIpv4SourceArbitraryBitmask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DottedQuad value) Set the property corresponding toIpv4MatchArbitraryBitmaskFields.getIpv4SourceArbitraryBitmask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv4MatchArbitraryBitMaskBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4MatchArbitraryBitMask> 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 Ipv4MatchArbitraryBitMaskBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4MatchArbitraryBitMask>> 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 newIpv4MatchArbitraryBitMask
instance.- Returns:
- A new
Ipv4MatchArbitraryBitMask
instance.
-