Class IpAdjacencyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.subobject.nai.IpAdjacencyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpAdjacency>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpAdjacency,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpAdjacencyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IpAdjacency>
Class that buildsIpAdjacencyBuilder
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:
IpAdjacencyBuilder createTarget(int fooXyzzy, int barBaz) { return new IpAdjacencyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpAdjacencyBuilder, 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 oportunities, 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:
IpAdjacencyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpAdjacencyBuilder()
IpAdjacencyBuilder(IpAdjacency base)
-
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)
IpAdjacency
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getLocalIpAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
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)
IpAdjacencyBuilder
setRemoteIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
-
-
Constructor Detail
-
IpAdjacencyBuilder
public IpAdjacencyBuilder()
-
IpAdjacencyBuilder
public IpAdjacencyBuilder(IpAdjacency base)
-
-
Method Detail
-
getLocalIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getLocalIpAddress()
-
getRemoteIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getRemoteIpAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAdjacency>> E$$ augmentation(Class<E$$> augmentationType)
-
setLocalIpAddress
public IpAdjacencyBuilder setLocalIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
setRemoteIpAddress
public IpAdjacencyBuilder setRemoteIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
-
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 IpAdjacency build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpAdjacency>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpAdjacency,IllegalArgumentException>
-
-