Class DestinationFlowspecCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationFlowspecCaseBuilder
-
@Generated("mdsal-binding-generator") public class DestinationFlowspecCaseBuilder extends Object
Class that buildsDestinationFlowspecCaseinstances. 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:
DestinationFlowspecCase createDestinationFlowspecCase(int fooXyzzy, int barBaz) { return new DestinationFlowspecCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of DestinationFlowspecCase, 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:
DestinationFlowspecCase
- 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 DestinationFlowspecCaseBuilder()Construct an empty builder.DestinationFlowspecCaseBuilder(FlowspecDestinationIpv4 arg)Construct a new builder initialized from specifiedFlowspecDestinationIpv4.DestinationFlowspecCaseBuilder(DestinationFlowspecCase base)Construct a builder initialized with state from specifiedDestinationFlowspecCase.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DestinationFlowspecCaseBuilderaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecCase> augmentation)Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecCase>>
E$$augmentation(Class<E$$> augmentationType)Return the specified augmentation, if it is present in this builder.@NonNull DestinationFlowspecCasebuild()A newDestinationFlowspecCaseinstance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.DestinationFlowspecIpv4getDestinationFlowspecIpv4()Return current value associated with the property corresponding toFlowspecDestinationIpv4.getDestinationFlowspecIpv4().DestinationFlowspecCaseBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecCase>> augmentationType)Remove an augmentation from this builder's product.DestinationFlowspecCaseBuildersetDestinationFlowspecIpv4(DestinationFlowspecIpv4 value)Set the property corresponding toFlowspecDestinationIpv4.getDestinationFlowspecIpv4()to the specified value.
-
-
-
Constructor Detail
-
DestinationFlowspecCaseBuilder
public DestinationFlowspecCaseBuilder()
Construct an empty builder.
-
DestinationFlowspecCaseBuilder
public DestinationFlowspecCaseBuilder(FlowspecDestinationIpv4 arg)
Construct a new builder initialized from specifiedFlowspecDestinationIpv4.- Parameters:
arg- FlowspecDestinationIpv4 from which the builder should be initialized
-
DestinationFlowspecCaseBuilder
public DestinationFlowspecCaseBuilder(DestinationFlowspecCase base)
Construct a builder initialized with state from specifiedDestinationFlowspecCase.- Parameters:
base- DestinationFlowspecCase from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg- grouping object- Throws:
IllegalArgumentException- if given argument is none of valid types or has property with incompatible value
-
getDestinationFlowspecIpv4
public DestinationFlowspecIpv4 getDestinationFlowspecIpv4()
Return current value associated with the property corresponding toFlowspecDestinationIpv4.getDestinationFlowspecIpv4().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecCase>> 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
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
setDestinationFlowspecIpv4
public DestinationFlowspecCaseBuilder setDestinationFlowspecIpv4(DestinationFlowspecIpv4 value)
Set the property corresponding toFlowspecDestinationIpv4.getDestinationFlowspecIpv4()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public DestinationFlowspecCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecCase> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public DestinationFlowspecCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationFlowspecCase>> 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 DestinationFlowspecCase build()
A newDestinationFlowspecCaseinstance.- Returns:
- A new
DestinationFlowspecCaseinstance.
-
-