Class NxmOfIpSrcBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.ip.src.grouping.NxmOfIpSrcBuilder
Class that builds
NxmOfIpSrc
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:
NxmOfIpSrc createNxmOfIpSrc(int fooXyzzy, int barBaz) {
return new NxmOfIpSrcBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NxmOfIpSrc, 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.Construct a new builder initialized from specifiedIpv4AddressGrouping
.NxmOfIpSrcBuilder
(NxmOfIpSrc base) Construct a builder initialized with state from specifiedNxmOfIpSrc
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIpSrc> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIpSrc>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull NxmOfIpSrc
build()
A newNxmOfIpSrc
instance.static @NonNull NxmOfIpSrc
empty()
Get empty instance of NxmOfIpSrc.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 toIpv4AddressGrouping.getIpv4Address()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIpSrc>> augmentationType) Remove an augmentation from this builder's product.setIpv4Address
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value) Set the property corresponding toIpv4AddressGrouping.getIpv4Address()
to the specified value.
-
Constructor Details
-
NxmOfIpSrcBuilder
public NxmOfIpSrcBuilder()Construct an empty builder. -
NxmOfIpSrcBuilder
Construct a new builder initialized from specifiedIpv4AddressGrouping
.- Parameters:
arg
- Ipv4AddressGrouping from which the builder should be initialized
-
NxmOfIpSrcBuilder
Construct a builder initialized with state from specifiedNxmOfIpSrc
.- Parameters:
base
- NxmOfIpSrc 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
-
empty
Get empty instance of NxmOfIpSrc.- Returns:
- An empty
NxmOfIpSrc
-
getIpv4Address
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4Address()Return current value associated with the property corresponding toIpv4AddressGrouping.getIpv4Address()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIpSrc>> 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
-
setIpv4Address
public NxmOfIpSrcBuilder setIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value) Set the property corresponding toIpv4AddressGrouping.getIpv4Address()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxmOfIpSrcBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIpSrc> 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 NxmOfIpSrcBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfIpSrc>> 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 newNxmOfIpSrc
instance.- Returns:
- A new
NxmOfIpSrc
instance.
-