Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.rp
Class TlvsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.rp.object.rp.TlvsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Tlvs>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Tlvs,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TlvsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Tlvs>
Class that buildsTlvs
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:
Tlvs createTlvs(int fooXyzzy, int barBaz) { return new TlvsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Tlvs, 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:
Tlvs
,Builder
-
-
Constructor Summary
Constructors Constructor Description TlvsBuilder()
TlvsBuilder(OrderTlv arg)
TlvsBuilder(PathSetupTypeTlv arg)
TlvsBuilder(Tlvs base)
TlvsBuilder(VendorInformationTlvs arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TlvsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>>
E$$augmentation(Class<E$$> augmentationType)
Tlvs
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Order
getOrder()
PathSetupType
getPathSetupType()
List<VendorInformationTlv>
getVendorInformationTlv()
TlvsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>> augmentationType)
Remove an augmentation from this builder's product.TlvsBuilder
setOrder(Order value)
TlvsBuilder
setPathSetupType(PathSetupType value)
TlvsBuilder
setVendorInformationTlv(List<VendorInformationTlv> values)
-
-
-
Constructor Detail
-
TlvsBuilder
public TlvsBuilder()
-
TlvsBuilder
public TlvsBuilder(OrderTlv arg)
-
TlvsBuilder
public TlvsBuilder(VendorInformationTlvs arg)
-
TlvsBuilder
public TlvsBuilder(PathSetupTypeTlv arg)
-
TlvsBuilder
public TlvsBuilder(Tlvs 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:- VendorInformationTlvs
- PathSetupTypeTlv
- OrderTlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getOrder
public Order getOrder()
-
getPathSetupType
public PathSetupType getPathSetupType()
-
getVendorInformationTlv
public List<VendorInformationTlv> getVendorInformationTlv()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>> E$$ augmentation(Class<E$$> augmentationType)
-
setOrder
public TlvsBuilder setOrder(Order value)
-
setPathSetupType
public TlvsBuilder setPathSetupType(PathSetupType value)
-
setVendorInformationTlv
public TlvsBuilder setVendorInformationTlv(List<VendorInformationTlv> values)
-
addAugmentation
public TlvsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs> 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 TlvsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tlvs>> 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 Tlvs build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Tlvs>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Tlvs,IllegalArgumentException>
-
-