Class MplsLabelEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.path.binding.tlv.path.binding.binding.type.value.MplsLabelEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MplsLabelEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MplsLabelEntry,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MplsLabelEntryBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MplsLabelEntry>
Class that buildsMplsLabelEntry
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:
MplsLabelEntry createMplsLabelEntry(int fooXyzzy, int barBaz) { return new MplsLabelEntryBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MplsLabelEntry, 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:
MplsLabelEntry
,Builder
-
-
Constructor Summary
Constructors Constructor Description MplsLabelEntryBuilder()
MplsLabelEntryBuilder(MplsLabelEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MplsLabelEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MplsLabelEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MplsLabelEntry>>
E$$augmentation(Class<E$$> augmentationType)
MplsLabelEntry
build()
Boolean
getBottomOfStack()
MplsLabel
getLabel()
org.opendaylight.yangtools.yang.common.Uint8
getTimeToLive()
org.opendaylight.yangtools.yang.common.Uint8
getTrafficClass()
MplsLabelEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MplsLabelEntry>> augmentationType)
Remove an augmentation from this builder's product.MplsLabelEntryBuilder
setBottomOfStack(Boolean value)
MplsLabelEntryBuilder
setLabel(MplsLabel value)
MplsLabelEntryBuilder
setTimeToLive(org.opendaylight.yangtools.yang.common.Uint8 value)
MplsLabelEntryBuilder
setTrafficClass(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
MplsLabelEntryBuilder
public MplsLabelEntryBuilder()
-
MplsLabelEntryBuilder
public MplsLabelEntryBuilder(MplsLabelEntry base)
-
-
Method Detail
-
getBottomOfStack
public Boolean getBottomOfStack()
-
getLabel
public MplsLabel getLabel()
-
getTimeToLive
public org.opendaylight.yangtools.yang.common.Uint8 getTimeToLive()
-
getTrafficClass
public org.opendaylight.yangtools.yang.common.Uint8 getTrafficClass()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MplsLabelEntry>> E$$ augmentation(Class<E$$> augmentationType)
-
setBottomOfStack
public MplsLabelEntryBuilder setBottomOfStack(Boolean value)
-
setLabel
public MplsLabelEntryBuilder setLabel(MplsLabel value)
-
setTimeToLive
public MplsLabelEntryBuilder setTimeToLive(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTrafficClass
public MplsLabelEntryBuilder setTrafficClass(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public MplsLabelEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MplsLabelEntry> 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 MplsLabelEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MplsLabelEntry>> 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 MplsLabelEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MplsLabelEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MplsLabelEntry,IllegalArgumentException>
-
-