Class IpPortLocatorEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.supported.tunnels.parameters.IpPortLocatorEntryBuilder
-
@Generated("mdsal-binding-generator") public class IpPortLocatorEntryBuilder extends Object
Class that buildsIpPortLocatorEntry
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:
IpPortLocatorEntry createIpPortLocatorEntry(int fooXyzzy, int barBaz) { return new IpPortLocatorEntryBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpPortLocatorEntry, 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:
IpPortLocatorEntry
- 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
-
-
Constructor Summary
Constructors Constructor Description IpPortLocatorEntryBuilder()
Construct an empty builder.IpPortLocatorEntryBuilder(IpPortLocator arg)
Construct a new builder initialized from specifiedIpPortLocator
.IpPortLocatorEntryBuilder(IpPortLocatorEntry base)
Construct a builder initialized with state from specifiedIpPortLocatorEntry
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpPortLocatorEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPortLocatorEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortLocatorEntry>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull IpPortLocatorEntry
build()
A newIpPortLocatorEntry
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.IpAddress
getIp()
Return current value associated with the property corresponding toIpPortLocator.getIp()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getPort()
Return current value associated with the property corresponding toIpPortLocator.getPort()
.IpPortLocatorEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortLocatorEntry>> augmentationType)
Remove an augmentation from this builder's product.IpPortLocatorEntryBuilder
setIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toIpPortLocator.getIp()
to the specified value.IpPortLocatorEntryBuilder
setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toIpPortLocator.getPort()
to the specified value.
-
-
-
Constructor Detail
-
IpPortLocatorEntryBuilder
public IpPortLocatorEntryBuilder()
Construct an empty builder.
-
IpPortLocatorEntryBuilder
public IpPortLocatorEntryBuilder(IpPortLocator arg)
Construct a new builder initialized from specifiedIpPortLocator
.- Parameters:
arg
- IpPortLocator from which the builder should be initialized
-
IpPortLocatorEntryBuilder
public IpPortLocatorEntryBuilder(IpPortLocatorEntry base)
Construct a builder initialized with state from specifiedIpPortLocatorEntry
.- Parameters:
base
- IpPortLocatorEntry from which the builder should be initialized
-
-
Method Detail
-
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
-
getIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIp()
Return current value associated with the property corresponding toIpPortLocator.getIp()
.- Returns:
- current value
-
getPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
Return current value associated with the property corresponding toIpPortLocator.getPort()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortLocatorEntry>> 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
-
setIp
public IpPortLocatorEntryBuilder setIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toIpPortLocator.getIp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPort
public IpPortLocatorEntryBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toIpPortLocator.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IpPortLocatorEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPortLocatorEntry> 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 IpPortLocatorEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPortLocatorEntry>> 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
public @NonNull IpPortLocatorEntry build()
A newIpPortLocatorEntry
instance.- Returns:
- A new
IpPortLocatorEntry
instance.
-
-