Class IpProtoCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.IpProtoCaseBuilder
-
@Generated("mdsal-binding-generator") public class IpProtoCaseBuilder extends Object
Class that buildsIpProtoCase
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:
IpProtoCase createIpProtoCase(int fooXyzzy, int barBaz) { return new IpProtoCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpProtoCase, 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:
IpProtoCase
- 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 IpProtoCaseBuilder()
Construct an empty builder.IpProtoCaseBuilder(IpProtoCase base)
Construct a builder initialized with state from specifiedIpProtoCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpProtoCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpProtoCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProtoCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull IpProtoCase
build()
A newIpProtoCase
instance.IpProto
getIpProto()
Return current value associated with the property corresponding toIpProtoCase.getIpProto()
.IpProtoCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProtoCase>> augmentationType)
Remove an augmentation from this builder's product.IpProtoCaseBuilder
setIpProto(IpProto value)
Set the property corresponding toIpProtoCase.getIpProto()
to the specified value.
-
-
-
Constructor Detail
-
IpProtoCaseBuilder
public IpProtoCaseBuilder()
Construct an empty builder.
-
IpProtoCaseBuilder
public IpProtoCaseBuilder(IpProtoCase base)
Construct a builder initialized with state from specifiedIpProtoCase
.- Parameters:
base
- IpProtoCase from which the builder should be initialized
-
-
Method Detail
-
getIpProto
public IpProto getIpProto()
Return current value associated with the property corresponding toIpProtoCase.getIpProto()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProtoCase>> 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
-
setIpProto
public IpProtoCaseBuilder setIpProto(IpProto value)
Set the property corresponding toIpProtoCase.getIpProto()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IpProtoCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpProtoCase> 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 IpProtoCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProtoCase>> 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 IpProtoCase build()
A newIpProtoCase
instance.- Returns:
- A new
IpProtoCase
instance.
-
-