Class NeighborSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.NeighborSetBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NeighborSet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NeighborSet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NeighborSetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NeighborSet>
Class that buildsNeighborSetBuilder
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:
NeighborSetBuilder createTarget(int fooXyzzy, int barBaz) { return new NeighborSetBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NeighborSetBuilder, 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:
NeighborSetBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NeighborSetBuilder()
NeighborSetBuilder(NeighborSet base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NeighborSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet>>
E$$augmentation(Class<E$$> augmentationType)
NeighborSet
build()
Map<NeighborKey,Neighbor>
getNeighbor()
String
getNeighborSetName()
NeighborSetKey
key()
NeighborSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet>> augmentationType)
Remove an augmentation from this builder's product.NeighborSetBuilder
setNeighbor(List<Neighbor> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNeighbor(Map)
instead.NeighborSetBuilder
setNeighbor(Map<NeighborKey,Neighbor> values)
NeighborSetBuilder
setNeighborSetName(String value)
NeighborSetBuilder
withKey(NeighborSetKey key)
-
-
-
Constructor Detail
-
NeighborSetBuilder
public NeighborSetBuilder()
-
NeighborSetBuilder
public NeighborSetBuilder(NeighborSet base)
-
-
Method Detail
-
key
public NeighborSetKey key()
-
getNeighbor
public Map<NeighborKey,Neighbor> getNeighbor()
-
getNeighborSetName
public String getNeighborSetName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public NeighborSetBuilder withKey(NeighborSetKey key)
-
setNeighbor
public NeighborSetBuilder setNeighbor(Map<NeighborKey,Neighbor> values)
-
setNeighbor
@Deprecated(forRemoval=true) public NeighborSetBuilder setNeighbor(List<Neighbor> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNeighbor(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
setNeighborSetName
public NeighborSetBuilder setNeighborSetName(String value)
-
addAugmentation
public NeighborSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet> 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 NeighborSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet>> 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 NeighborSet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NeighborSet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NeighborSet,IllegalArgumentException>
-
-