Class NeighborBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.neighbor.set.NeighborBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Neighbor>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Neighbor,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NeighborBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Neighbor>
Class that buildsNeighbor
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:
Neighbor createNeighbor(int fooXyzzy, int barBaz) { return new NeighborBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Neighbor, 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:
Neighbor
,Builder
-
-
Constructor Summary
Constructors Constructor Description NeighborBuilder()
NeighborBuilder(Neighbor base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NeighborBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Neighbor> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbor>>
E$$augmentation(Class<E$$> augmentationType)
Neighbor
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getAddress()
NeighborKey
key()
NeighborBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbor>> augmentationType)
Remove an augmentation from this builder's product.NeighborBuilder
setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
NeighborBuilder
withKey(NeighborKey key)
-
-
-
Constructor Detail
-
NeighborBuilder
public NeighborBuilder()
-
NeighborBuilder
public NeighborBuilder(Neighbor base)
-
-
Method Detail
-
key
public NeighborKey key()
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbor>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public NeighborBuilder withKey(NeighborKey key)
-
setAddress
public NeighborBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
addAugmentation
public NeighborBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Neighbor> 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 NeighborBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Neighbor>> 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 Neighbor build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Neighbor>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Neighbor,IllegalArgumentException>
-
-