Class PrefixSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.prefix.set.PrefixSetBuilder
-
@Generated("mdsal-binding-generator") public class PrefixSetBuilder extends Object
Class that buildsPrefixSet
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:
PrefixSet createPrefixSet(int fooXyzzy, int barBaz) { return new PrefixSetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixSet, 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:
PrefixSet
- 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 PrefixSetBuilder()
Construct an empty builder.PrefixSetBuilder(PrefixSet base)
Construct a builder initialized with state from specifiedPrefixSet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSet>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PrefixSet
build()
A newPrefixSet
instance.Map<PrefixKey,Prefix>
getPrefix()
Return current value associated with the property corresponding toPrefixSet.getPrefix()
.String
getPrefixSetName()
Return current value associated with the property corresponding toPrefixSet.getPrefixSetName()
.PrefixSetKey
key()
Return current value associated with the property corresponding toPrefixSet.key()
.PrefixSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSet>> augmentationType)
Remove an augmentation from this builder's product.PrefixSetBuilder
setPrefix(Map<PrefixKey,Prefix> values)
Set the property corresponding toPrefixSet.getPrefix()
to the specified value.PrefixSetBuilder
setPrefixSetName(String value)
Set the property corresponding toPrefixSet.getPrefixSetName()
to the specified value.PrefixSetBuilder
withKey(PrefixSetKey key)
-
-
-
Method Detail
-
key
public PrefixSetKey key()
Return current value associated with the property corresponding toPrefixSet.key()
.- Returns:
- current value
-
getPrefix
public Map<PrefixKey,Prefix> getPrefix()
Return current value associated with the property corresponding toPrefixSet.getPrefix()
.- Returns:
- current value
-
getPrefixSetName
public String getPrefixSetName()
Return current value associated with the property corresponding toPrefixSet.getPrefixSetName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSet>> 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
-
withKey
public PrefixSetBuilder withKey(PrefixSetKey key)
-
setPrefix
public PrefixSetBuilder setPrefix(Map<PrefixKey,Prefix> values)
Set the property corresponding toPrefixSet.getPrefix()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setPrefixSetName
public PrefixSetBuilder setPrefixSetName(String value)
Set the property corresponding toPrefixSet.getPrefixSetName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PrefixSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSet> 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 PrefixSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSet>> 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
-
-