Class ApplicationDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.application.data.ApplicationDataBuilder
-
@Generated("mdsal-binding-generator") public class ApplicationDataBuilder extends java.lang.Object
Class that buildsApplicationData
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:
ApplicationData createApplicationData(int fooXyzzy, int barBaz) { return new ApplicationDataBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ApplicationData, 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:
ApplicationData
- 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 ApplicationDataBuilder()
Construct an empty builder.ApplicationDataBuilder(ApplicationData base)
Construct a builder initialized with state from specifiedApplicationData
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApplicationDataBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationData> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationData>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ApplicationData
build()
A newApplicationData
instance.SimpleAddress
getAddress()
Return current value associated with the property corresponding toApplicationData.getAddress()
.java.lang.Integer
getIpTos()
Return current value associated with the property corresponding toApplicationData.getIpTos()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getLocalPortHigh()
Return current value associated with the property corresponding toApplicationData.getLocalPortHigh()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getLocalPortLow()
Return current value associated with the property corresponding toApplicationData.getLocalPortLow()
.org.opendaylight.yangtools.yang.common.Uint8
getProtocol()
Return current value associated with the property corresponding toApplicationData.getProtocol()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getRemotePortHigh()
Return current value associated with the property corresponding toApplicationData.getRemotePortHigh()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getRemotePortLow()
Return current value associated with the property corresponding toApplicationData.getRemotePortLow()
.ApplicationDataBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationData>> augmentationType)
Remove an augmentation from this builder's product.ApplicationDataBuilder
setAddress(SimpleAddress value)
Set the property corresponding toApplicationData.getAddress()
to the specified value.ApplicationDataBuilder
setIpTos(java.lang.Integer value)
Set the property corresponding toApplicationData.getIpTos()
to the specified value.ApplicationDataBuilder
setLocalPortHigh(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getLocalPortHigh()
to the specified value.ApplicationDataBuilder
setLocalPortLow(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getLocalPortLow()
to the specified value.ApplicationDataBuilder
setProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toApplicationData.getProtocol()
to the specified value.ApplicationDataBuilder
setRemotePortHigh(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getRemotePortHigh()
to the specified value.ApplicationDataBuilder
setRemotePortLow(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getRemotePortLow()
to the specified value.
-
-
-
Constructor Detail
-
ApplicationDataBuilder
public ApplicationDataBuilder()
Construct an empty builder.
-
ApplicationDataBuilder
public ApplicationDataBuilder(ApplicationData base)
Construct a builder initialized with state from specifiedApplicationData
.- Parameters:
base
- ApplicationData from which the builder should be initialized
-
-
Method Detail
-
getAddress
public SimpleAddress getAddress()
Return current value associated with the property corresponding toApplicationData.getAddress()
.- Returns:
- current value
-
getIpTos
public java.lang.Integer getIpTos()
Return current value associated with the property corresponding toApplicationData.getIpTos()
.- Returns:
- current value
-
getLocalPortHigh
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPortHigh()
Return current value associated with the property corresponding toApplicationData.getLocalPortHigh()
.- Returns:
- current value
-
getLocalPortLow
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLocalPortLow()
Return current value associated with the property corresponding toApplicationData.getLocalPortLow()
.- Returns:
- current value
-
getProtocol
public org.opendaylight.yangtools.yang.common.Uint8 getProtocol()
Return current value associated with the property corresponding toApplicationData.getProtocol()
.- Returns:
- current value
-
getRemotePortHigh
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePortHigh()
Return current value associated with the property corresponding toApplicationData.getRemotePortHigh()
.- Returns:
- current value
-
getRemotePortLow
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getRemotePortLow()
Return current value associated with the property corresponding toApplicationData.getRemotePortLow()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationData>> E$$ augmentation(java.lang.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:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setAddress
public ApplicationDataBuilder setAddress(SimpleAddress value)
Set the property corresponding toApplicationData.getAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpTos
public ApplicationDataBuilder setIpTos(java.lang.Integer value)
Set the property corresponding toApplicationData.getIpTos()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalPortHigh
public ApplicationDataBuilder setLocalPortHigh(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getLocalPortHigh()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalPortLow
public ApplicationDataBuilder setLocalPortLow(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getLocalPortLow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtocol
public ApplicationDataBuilder setProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toApplicationData.getProtocol()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemotePortHigh
public ApplicationDataBuilder setRemotePortHigh(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getRemotePortHigh()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemotePortLow
public ApplicationDataBuilder setRemotePortLow(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
Set the property corresponding toApplicationData.getRemotePortLow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ApplicationDataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationData> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public ApplicationDataBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ApplicationData>> 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 ApplicationData build()
A newApplicationData
instance.- Returns:
- A new
ApplicationData
instance.
-
-