Class SwitchFeaturesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.SwitchFeaturesBuilder
-
@Generated("mdsal-binding-generator") public class SwitchFeaturesBuilder extends Object
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
- 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 SwitchFeaturesBuilder()
Construct an empty builder.SwitchFeaturesBuilder(SwitchFeatures base)
Construct a builder initialized with state from specifiedSwitchFeatures
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull SwitchFeatures
build()
A newSwitchFeatures
instance.Set<Class<? extends FeatureCapability>>
getCapabilities()
Return current value associated with the property corresponding toSwitchFeatures.getCapabilities()
.org.opendaylight.yangtools.yang.common.Uint32
getMaxBuffers()
Return current value associated with the property corresponding toSwitchFeatures.getMaxBuffers()
.org.opendaylight.yangtools.yang.common.Uint8
getMaxTables()
Return current value associated with the property corresponding toSwitchFeatures.getMaxTables()
.SwitchFeaturesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures>> augmentationType)
Remove an augmentation from this builder's product.SwitchFeaturesBuilder
setCapabilities(Set<Class<? extends FeatureCapability>> values)
Set the property corresponding toSwitchFeatures.getCapabilities()
to the specified value.SwitchFeaturesBuilder
setMaxBuffers(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSwitchFeatures.getMaxBuffers()
to the specified value.SwitchFeaturesBuilder
setMaxTables(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toSwitchFeatures.getMaxTables()
to the specified value.
-
-
-
Constructor Detail
-
SwitchFeaturesBuilder
public SwitchFeaturesBuilder()
Construct an empty builder.
-
SwitchFeaturesBuilder
public SwitchFeaturesBuilder(SwitchFeatures base)
Construct a builder initialized with state from specifiedSwitchFeatures
.- Parameters:
base
- SwitchFeatures from which the builder should be initialized
-
-
Method Detail
-
getCapabilities
public Set<Class<? extends FeatureCapability>> getCapabilities()
Return current value associated with the property corresponding toSwitchFeatures.getCapabilities()
.- Returns:
- current value
-
getMaxBuffers
public org.opendaylight.yangtools.yang.common.Uint32 getMaxBuffers()
Return current value associated with the property corresponding toSwitchFeatures.getMaxBuffers()
.- Returns:
- current value
-
getMaxTables
public org.opendaylight.yangtools.yang.common.Uint8 getMaxTables()
Return current value associated with the property corresponding toSwitchFeatures.getMaxTables()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFeatures>> 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
-
setCapabilities
public SwitchFeaturesBuilder setCapabilities(Set<Class<? extends FeatureCapability>> values)
Set the property corresponding toSwitchFeatures.getCapabilities()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMaxBuffers
public SwitchFeaturesBuilder setMaxBuffers(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSwitchFeatures.getMaxBuffers()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxTables
public SwitchFeaturesBuilder setMaxTables(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toSwitchFeatures.getMaxTables()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull SwitchFeatures build()
A newSwitchFeatures
instance.- Returns:
- A new
SwitchFeatures
instance.
-
-