Class PrefixCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.PrefixCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PrefixCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PrefixCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PrefixCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PrefixCase>
Class that buildsPrefixCaseBuilder
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:
PrefixCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new PrefixCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixCaseBuilder, 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:
PrefixCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixCaseBuilder()
PrefixCaseBuilder(PrefixCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixCase>>
E$$augmentation(Class<E$$> augmentationType)
PrefixCase
build()
AdvertisingNodeDescriptors
getAdvertisingNodeDescriptors()
PrefixDescriptors
getPrefixDescriptors()
PrefixCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixCase>> augmentationType)
Remove an augmentation from this builder's product.PrefixCaseBuilder
setAdvertisingNodeDescriptors(AdvertisingNodeDescriptors value)
PrefixCaseBuilder
setPrefixDescriptors(PrefixDescriptors value)
-
-
-
Constructor Detail
-
PrefixCaseBuilder
public PrefixCaseBuilder()
-
PrefixCaseBuilder
public PrefixCaseBuilder(PrefixCase base)
-
-
Method Detail
-
getAdvertisingNodeDescriptors
public AdvertisingNodeDescriptors getAdvertisingNodeDescriptors()
-
getPrefixDescriptors
public PrefixDescriptors getPrefixDescriptors()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdvertisingNodeDescriptors
public PrefixCaseBuilder setAdvertisingNodeDescriptors(AdvertisingNodeDescriptors value)
-
setPrefixDescriptors
public PrefixCaseBuilder setPrefixDescriptors(PrefixDescriptors value)
-
addAugmentation
public PrefixCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixCase> 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 PrefixCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixCase>> 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 PrefixCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PrefixCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PrefixCase,IllegalArgumentException>
-
-