Class FlowHashIdMapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.hash.id.mapping.FlowHashIdMapBuilder
-
@Generated("mdsal-binding-generator") public class FlowHashIdMapBuilder extends Object
Class that buildsFlowHashIdMap
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:
FlowHashIdMap createFlowHashIdMap(int fooXyzzy, int barBaz) { return new FlowHashIdMapBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowHashIdMap, 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:
FlowHashIdMap
- 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 FlowHashIdMapBuilder()
Construct an empty builder.FlowHashIdMapBuilder(FlowHashIdMap base)
Construct a builder initialized with state from specifiedFlowHashIdMap
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowHashIdMapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowHashIdMap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowHashIdMap>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowHashIdMap
build()
A newFlowHashIdMap
instance.FlowId
getFlowId()
Return current value associated with the property corresponding toFlowHashIdMap.getFlowId()
.String
getHash()
Return current value associated with the property corresponding toFlowHashIdMap.getHash()
.FlowHashIdMapKey
key()
Return current value associated with the property corresponding toFlowHashIdMap.key()
.FlowHashIdMapBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowHashIdMap>> augmentationType)
Remove an augmentation from this builder's product.FlowHashIdMapBuilder
setFlowId(FlowId value)
Set the property corresponding toFlowHashIdMap.getFlowId()
to the specified value.FlowHashIdMapBuilder
setHash(String value)
Set the property corresponding toFlowHashIdMap.getHash()
to the specified value.FlowHashIdMapBuilder
withKey(FlowHashIdMapKey key)
-
-
-
Constructor Detail
-
FlowHashIdMapBuilder
public FlowHashIdMapBuilder()
Construct an empty builder.
-
FlowHashIdMapBuilder
public FlowHashIdMapBuilder(FlowHashIdMap base)
Construct a builder initialized with state from specifiedFlowHashIdMap
.- Parameters:
base
- FlowHashIdMap from which the builder should be initialized
-
-
Method Detail
-
key
public FlowHashIdMapKey key()
Return current value associated with the property corresponding toFlowHashIdMap.key()
.- Returns:
- current value
-
getFlowId
public FlowId getFlowId()
Return current value associated with the property corresponding toFlowHashIdMap.getFlowId()
.- Returns:
- current value
-
getHash
public String getHash()
Return current value associated with the property corresponding toFlowHashIdMap.getHash()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowHashIdMap>> 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 FlowHashIdMapBuilder withKey(FlowHashIdMapKey key)
-
setFlowId
public FlowHashIdMapBuilder setFlowId(FlowId value)
Set the property corresponding toFlowHashIdMap.getFlowId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHash
public FlowHashIdMapBuilder setHash(String value)
Set the property corresponding toFlowHashIdMap.getHash()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowHashIdMapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowHashIdMap> 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 FlowHashIdMapBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowHashIdMap>> 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 FlowHashIdMap build()
A newFlowHashIdMap
instance.- Returns:
- A new
FlowHashIdMap
instance.
-
-