Class DefinedSetsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.DefinedSetsBuilder
Class that builds
DefinedSets
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:
DefinedSets createDefinedSets(int fooXyzzy, int barBaz) {
return new DefinedSetsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of DefinedSets, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedGenericDefinedSets
.Construct a builder initialized with state from specifiedDefinedSets
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<DefinedSets> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<DefinedSets>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull DefinedSets
build()
A newDefinedSets
instance.static @NonNull DefinedSets
empty()
Get empty instance of DefinedSets.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toGenericDefinedSets.getNeighborSets()
.Return current value associated with the property corresponding toGenericDefinedSets.getPrefixSets()
.Return current value associated with the property corresponding toGenericDefinedSets.getTagSets()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<DefinedSets>> augmentationType) Remove an augmentation from this builder's product.setNeighborSets
(NeighborSets value) Set the property corresponding toGenericDefinedSets.getNeighborSets()
to the specified value.setPrefixSets
(PrefixSets value) Set the property corresponding toGenericDefinedSets.getPrefixSets()
to the specified value.setTagSets
(TagSets value) Set the property corresponding toGenericDefinedSets.getTagSets()
to the specified value.
-
Constructor Details
-
DefinedSetsBuilder
public DefinedSetsBuilder()Construct an empty builder. -
DefinedSetsBuilder
Construct a new builder initialized from specifiedGenericDefinedSets
.- Parameters:
arg
- GenericDefinedSets from which the builder should be initialized
-
DefinedSetsBuilder
Construct a builder initialized with state from specifiedDefinedSets
.- Parameters:
base
- DefinedSets from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
empty
Get empty instance of DefinedSets.- Returns:
- An empty
DefinedSets
-
getNeighborSets
Return current value associated with the property corresponding toGenericDefinedSets.getNeighborSets()
.- Returns:
- current value
-
getPrefixSets
Return current value associated with the property corresponding toGenericDefinedSets.getPrefixSets()
.- Returns:
- current value
-
getTagSets
Return current value associated with the property corresponding toGenericDefinedSets.getTagSets()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<DefinedSets>> 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
-
setNeighborSets
Set the property corresponding toGenericDefinedSets.getNeighborSets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefixSets
Set the property corresponding toGenericDefinedSets.getPrefixSets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTagSets
Set the property corresponding toGenericDefinedSets.getTagSets()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DefinedSetsBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<DefinedSets> 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 DefinedSetsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<DefinedSets>> 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
A newDefinedSets
instance.- Returns:
- A new
DefinedSets
instance.
-