Class PrefixSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.prefix.set.PrefixSetBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PrefixSet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PrefixSet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PrefixSetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PrefixSet>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixSetBuilder()
PrefixSetBuilder(PrefixSet base)
-
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)
PrefixSet
build()
Map<PrefixKey,Prefix>
getPrefix()
String
getPrefixSetName()
PrefixSetKey
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)
PrefixSetBuilder
setPrefixSetName(String value)
PrefixSetBuilder
withKey(PrefixSetKey key)
-
-
-
Constructor Detail
-
PrefixSetBuilder
public PrefixSetBuilder()
-
PrefixSetBuilder
public PrefixSetBuilder(PrefixSet base)
-
-
Method Detail
-
key
public PrefixSetKey key()
-
getPrefixSetName
public String getPrefixSetName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixSet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PrefixSetBuilder withKey(PrefixSetKey key)
-
setPrefix
public PrefixSetBuilder setPrefix(Map<PrefixKey,Prefix> values)
-
setPrefixSetName
public PrefixSetBuilder setPrefixSetName(String value)
-
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
-
build
public PrefixSet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PrefixSet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PrefixSet,IllegalArgumentException>
-
-