Class ProtocolMatchFieldsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.ProtocolMatchFieldsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ProtocolMatchFields>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ProtocolMatchFields,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ProtocolMatchFieldsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ProtocolMatchFields>
Class that buildsProtocolMatchFieldsBuilder
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:
ProtocolMatchFieldsBuilder createTarget(int fooXyzzy, int barBaz) { return new ProtocolMatchFieldsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProtocolMatchFieldsBuilder, 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 oportunities, 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:
ProtocolMatchFieldsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ProtocolMatchFieldsBuilder()
ProtocolMatchFieldsBuilder(ProtocolMatchFields base)
ProtocolMatchFieldsBuilder(ProtocolMatchFields arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
ProtocolMatchFields
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getMplsBos()
org.opendaylight.yangtools.yang.common.Uint32
getMplsLabel()
org.opendaylight.yangtools.yang.common.Uint8
getMplsTc()
Pbb
getPbb()
ProtocolMatchFieldsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields>> augmentationType)
Remove an augmentation from this builder's product.ProtocolMatchFieldsBuilder
setMplsBos(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMplsBos(Uint8)
instead.ProtocolMatchFieldsBuilder
setMplsBos(org.opendaylight.yangtools.yang.common.Uint8 value)
ProtocolMatchFieldsBuilder
setMplsLabel(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMplsLabel(Uint32)
instead.ProtocolMatchFieldsBuilder
setMplsLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
ProtocolMatchFieldsBuilder
setMplsTc(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMplsTc(Uint8)
instead.ProtocolMatchFieldsBuilder
setMplsTc(org.opendaylight.yangtools.yang.common.Uint8 value)
ProtocolMatchFieldsBuilder
setPbb(Pbb value)
-
-
-
Constructor Detail
-
ProtocolMatchFieldsBuilder
public ProtocolMatchFieldsBuilder()
-
ProtocolMatchFieldsBuilder
public ProtocolMatchFieldsBuilder(ProtocolMatchFields arg)
-
ProtocolMatchFieldsBuilder
public ProtocolMatchFieldsBuilder(ProtocolMatchFields base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ProtocolMatchFields
- 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()
-
getMplsLabel
public org.opendaylight.yangtools.yang.common.Uint32 getMplsLabel()
-
getMplsTc
public org.opendaylight.yangtools.yang.common.Uint8 getMplsTc()
-
getPbb
public Pbb getPbb()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolMatchFields>> E$$ augmentation(Class<E$$> augmentationType)
-
setMplsBos
public ProtocolMatchFieldsBuilder setMplsBos(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMplsBos
@Deprecated(forRemoval=true) public ProtocolMatchFieldsBuilder setMplsBos(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMplsBos(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMplsLabel
public ProtocolMatchFieldsBuilder setMplsLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMplsLabel
@Deprecated(forRemoval=true) public ProtocolMatchFieldsBuilder setMplsLabel(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMplsLabel(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMplsTc
public ProtocolMatchFieldsBuilder setMplsTc(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMplsTc
@Deprecated(forRemoval=true) public ProtocolMatchFieldsBuilder setMplsTc(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMplsTc(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPbb
public ProtocolMatchFieldsBuilder setPbb(Pbb value)
-
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 ProtocolMatchFields build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ProtocolMatchFields>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ProtocolMatchFields,IllegalArgumentException>
-
-