Class LspIdentifiersBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.identifiers.tlv.LspIdentifiersBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LspIdentifiers>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LspIdentifiers,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LspIdentifiersBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LspIdentifiers>
Class that buildsLspIdentifiers
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:
LspIdentifiers createLspIdentifiers(int fooXyzzy, int barBaz) { return new LspIdentifiersBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LspIdentifiers, 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:
LspIdentifiers
,Builder
-
-
Constructor Summary
Constructors Constructor Description LspIdentifiersBuilder()
LspIdentifiersBuilder(LspIdentifiers base)
LspIdentifiersBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LspIdentifiersBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers>>
E$$augmentation(Class<E$$> augmentationType)
LspIdentifiers
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AddressFamily
getAddressFamily()
LspId
getLspId()
TunnelId
getTunnelId()
LspIdentifiersBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers>> augmentationType)
Remove an augmentation from this builder's product.LspIdentifiersBuilder
setAddressFamily(AddressFamily value)
LspIdentifiersBuilder
setLspId(LspId value)
LspIdentifiersBuilder
setTunnelId(TunnelId value)
-
-
-
Constructor Detail
-
LspIdentifiersBuilder
public LspIdentifiersBuilder()
-
LspIdentifiersBuilder
public LspIdentifiersBuilder(Tlv arg)
-
LspIdentifiersBuilder
public LspIdentifiersBuilder(LspIdentifiers 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
-
getAddressFamily
public AddressFamily getAddressFamily()
-
getLspId
public LspId getLspId()
-
getTunnelId
public TunnelId getTunnelId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers>> E$$ augmentation(Class<E$$> augmentationType)
-
setAddressFamily
public LspIdentifiersBuilder setAddressFamily(AddressFamily value)
-
setLspId
public LspIdentifiersBuilder setLspId(LspId value)
-
setTunnelId
public LspIdentifiersBuilder setTunnelId(TunnelId value)
-
addAugmentation
public LspIdentifiersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers> 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 LspIdentifiersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers>> 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 LspIdentifiers build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LspIdentifiers>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LspIdentifiers,IllegalArgumentException>
-
-