Class ProtocolMatchFieldsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.ProtocolMatchFieldsBuilder
-
@Generated("mdsal-binding-generator") public class ProtocolMatchFieldsBuilder extends Object
Class that buildsProtocolMatchFields
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:
ProtocolMatchFields createProtocolMatchFields(int fooXyzzy, int barBaz) { return new ProtocolMatchFieldsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProtocolMatchFields, 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:
ProtocolMatchFields
- 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 ProtocolMatchFieldsBuilder()
Construct an empty builder.ProtocolMatchFieldsBuilder(ProtocolMatchFields base)
Construct a builder initialized with state from specifiedProtocolMatchFields
.ProtocolMatchFieldsBuilder(ProtocolMatchFields arg)
Construct a new builder initialized from specifiedProtocolMatchFields
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProtocolMatchFieldsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ProtocolMatchFields
build()
A newProtocolMatchFields
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getMplsBos()
Return current value associated with the property corresponding toProtocolMatchFields.getMplsBos()
.org.opendaylight.yangtools.yang.common.Uint32
getMplsLabel()
Return current value associated with the property corresponding toProtocolMatchFields.getMplsLabel()
.org.opendaylight.yangtools.yang.common.Uint8
getMplsTc()
Return current value associated with the property corresponding toProtocolMatchFields.getMplsTc()
.Pbb
getPbb()
Return current value associated with the property corresponding toProtocolMatchFields.getPbb()
.ProtocolMatchFieldsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields>> augmentationType)
Remove an augmentation from this builder's product.ProtocolMatchFieldsBuilder
setMplsBos(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toProtocolMatchFields.getMplsBos()
to the specified value.ProtocolMatchFieldsBuilder
setMplsLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProtocolMatchFields.getMplsLabel()
to the specified value.ProtocolMatchFieldsBuilder
setMplsTc(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toProtocolMatchFields.getMplsTc()
to the specified value.ProtocolMatchFieldsBuilder
setPbb(Pbb value)
Set the property corresponding toProtocolMatchFields.getPbb()
to the specified value.
-
-
-
Constructor Detail
-
ProtocolMatchFieldsBuilder
public ProtocolMatchFieldsBuilder()
Construct an empty builder.
-
ProtocolMatchFieldsBuilder
public ProtocolMatchFieldsBuilder(ProtocolMatchFields arg)
Construct a new builder initialized from specifiedProtocolMatchFields
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ProtocolMatchFields from which the builder should be initialized
-
ProtocolMatchFieldsBuilder
public ProtocolMatchFieldsBuilder(ProtocolMatchFields base)
Construct a builder initialized with state from specifiedProtocolMatchFields
.- Parameters:
base
- ProtocolMatchFields 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
-
getMplsBos
public org.opendaylight.yangtools.yang.common.Uint8 getMplsBos()
Return current value associated with the property corresponding toProtocolMatchFields.getMplsBos()
.- Returns:
- current value
-
getMplsLabel
public org.opendaylight.yangtools.yang.common.Uint32 getMplsLabel()
Return current value associated with the property corresponding toProtocolMatchFields.getMplsLabel()
.- Returns:
- current value
-
getMplsTc
public org.opendaylight.yangtools.yang.common.Uint8 getMplsTc()
Return current value associated with the property corresponding toProtocolMatchFields.getMplsTc()
.- Returns:
- current value
-
getPbb
public Pbb getPbb()
Return current value associated with the property corresponding toProtocolMatchFields.getPbb()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields>> 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
-
setMplsBos
public ProtocolMatchFieldsBuilder setMplsBos(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toProtocolMatchFields.getMplsBos()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMplsLabel
public ProtocolMatchFieldsBuilder setMplsLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProtocolMatchFields.getMplsLabel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMplsTc
public ProtocolMatchFieldsBuilder setMplsTc(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toProtocolMatchFields.getMplsTc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPbb
public ProtocolMatchFieldsBuilder setPbb(Pbb value)
Set the property corresponding toProtocolMatchFields.getPbb()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ProtocolMatchFieldsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields> 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 ProtocolMatchFieldsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields>> 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 ProtocolMatchFields build()
A newProtocolMatchFields
instance.- Returns:
- A new
ProtocolMatchFields
instance.
-
-