Class IpAdjacencyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.subobject.nai.IpAdjacencyBuilder
-
@Generated("mdsal-binding-generator") public class IpAdjacencyBuilder extends Object
Class that buildsIpAdjacency
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:
IpAdjacency createIpAdjacency(int fooXyzzy, int barBaz) { return new IpAdjacencyBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpAdjacency, 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:
IpAdjacency
- 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 IpAdjacencyBuilder()
Construct an empty builder.IpAdjacencyBuilder(IpAdjacency base)
Construct a builder initialized with state from specifiedIpAdjacency
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpAdjacencyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpAdjacency> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAdjacency>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull IpAdjacency
build()
A newIpAdjacency
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getLocalIpAddress()
Return current value associated with the property corresponding toIpAdjacency.getLocalIpAddress()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getRemoteIpAddress()
Return current value associated with the property corresponding toIpAdjacency.getRemoteIpAddress()
.IpAdjacencyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAdjacency>> augmentationType)
Remove an augmentation from this builder's product.IpAdjacencyBuilder
setLocalIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toIpAdjacency.getLocalIpAddress()
to the specified value.IpAdjacencyBuilder
setRemoteIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toIpAdjacency.getRemoteIpAddress()
to the specified value.
-
-
-
Constructor Detail
-
IpAdjacencyBuilder
public IpAdjacencyBuilder()
Construct an empty builder.
-
IpAdjacencyBuilder
public IpAdjacencyBuilder(IpAdjacency base)
Construct a builder initialized with state from specifiedIpAdjacency
.- Parameters:
base
- IpAdjacency from which the builder should be initialized
-
-
Method Detail
-
getLocalIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getLocalIpAddress()
Return current value associated with the property corresponding toIpAdjacency.getLocalIpAddress()
.- Returns:
- current value
-
getRemoteIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getRemoteIpAddress()
Return current value associated with the property corresponding toIpAdjacency.getRemoteIpAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAdjacency>> 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
-
setLocalIpAddress
public IpAdjacencyBuilder setLocalIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toIpAdjacency.getLocalIpAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemoteIpAddress
public IpAdjacencyBuilder setRemoteIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toIpAdjacency.getRemoteIpAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IpAdjacencyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpAdjacency> 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 IpAdjacencyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAdjacency>> 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 IpAdjacency build()
A newIpAdjacency
instance.- Returns:
- A new
IpAdjacency
instance.
-
-