Class SwitchFeaturesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SwitchFeaturesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SwitchFeatures>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SwitchFeatures,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SwitchFeaturesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SwitchFeatures>
Class that buildsSwitchFeatures
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:
SwitchFeatures createSwitchFeatures(int fooXyzzy, int barBaz) { return new SwitchFeaturesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SwitchFeatures, 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:
SwitchFeatures
,Builder
-
-
Constructor Summary
Constructors Constructor Description SwitchFeaturesBuilder()
SwitchFeaturesBuilder(SwitchFeatures base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SwitchFeaturesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures>>
E$$augmentation(Class<E$$> augmentationType)
SwitchFeatures
build()
List<Class<? extends FeatureCapability>>
getCapabilities()
org.opendaylight.yangtools.yang.common.Uint32
getMaxBuffers()
org.opendaylight.yangtools.yang.common.Uint8
getMaxTables()
SwitchFeaturesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures>> augmentationType)
Remove an augmentation from this builder's product.SwitchFeaturesBuilder
setCapabilities(List<Class<? extends FeatureCapability>> values)
SwitchFeaturesBuilder
setMaxBuffers(org.opendaylight.yangtools.yang.common.Uint32 value)
SwitchFeaturesBuilder
setMaxTables(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
SwitchFeaturesBuilder
public SwitchFeaturesBuilder()
-
SwitchFeaturesBuilder
public SwitchFeaturesBuilder(SwitchFeatures base)
-
-
Method Detail
-
getCapabilities
public List<Class<? extends FeatureCapability>> getCapabilities()
-
getMaxBuffers
public org.opendaylight.yangtools.yang.common.Uint32 getMaxBuffers()
-
getMaxTables
public org.opendaylight.yangtools.yang.common.Uint8 getMaxTables()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures>> E$$ augmentation(Class<E$$> augmentationType)
-
setCapabilities
public SwitchFeaturesBuilder setCapabilities(List<Class<? extends FeatureCapability>> values)
-
setMaxBuffers
public SwitchFeaturesBuilder setMaxBuffers(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMaxTables
public SwitchFeaturesBuilder setMaxTables(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public SwitchFeaturesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures> 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 SwitchFeaturesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures>> 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 SwitchFeatures build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SwitchFeatures>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SwitchFeatures,IllegalArgumentException>
-
-