Class SrPceCapabilityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.pce.capability.tlv.SrPceCapabilityBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SrPceCapability>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SrPceCapability,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SrPceCapabilityBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SrPceCapability>
Class that buildsSrPceCapability
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:
SrPceCapability createSrPceCapability(int fooXyzzy, int barBaz) { return new SrPceCapabilityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SrPceCapability, 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:
SrPceCapability
,Builder
-
-
Constructor Summary
Constructors Constructor Description SrPceCapabilityBuilder()
SrPceCapabilityBuilder(SrPceCapability base)
SrPceCapabilityBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SrPceCapabilityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrPceCapability> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrPceCapability>>
E$$augmentation(Class<E$$> augmentationType)
SrPceCapability
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getMsd()
Boolean
getNFlag()
Boolean
getXFlag()
SrPceCapabilityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrPceCapability>> augmentationType)
Remove an augmentation from this builder's product.SrPceCapabilityBuilder
setMsd(org.opendaylight.yangtools.yang.common.Uint8 value)
SrPceCapabilityBuilder
setNFlag(Boolean value)
SrPceCapabilityBuilder
setXFlag(Boolean value)
-
-
-
Constructor Detail
-
SrPceCapabilityBuilder
public SrPceCapabilityBuilder()
-
SrPceCapabilityBuilder
public SrPceCapabilityBuilder(Tlv arg)
-
SrPceCapabilityBuilder
public SrPceCapabilityBuilder(SrPceCapability 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:- Tlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMsd
public org.opendaylight.yangtools.yang.common.Uint8 getMsd()
-
getNFlag
public Boolean getNFlag()
-
getXFlag
public Boolean getXFlag()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrPceCapability>> E$$ augmentation(Class<E$$> augmentationType)
-
setMsd
public SrPceCapabilityBuilder setMsd(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setNFlag
public SrPceCapabilityBuilder setNFlag(Boolean value)
-
setXFlag
public SrPceCapabilityBuilder setXFlag(Boolean value)
-
addAugmentation
public SrPceCapabilityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrPceCapability> 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 SrPceCapabilityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrPceCapability>> 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 SrPceCapability build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SrPceCapability>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SrPceCapability,IllegalArgumentException>
-
-