Class LspBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.object.LspBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Lsp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Lsp,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LspBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Lsp>
Class that buildsLsp
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:
Lsp createLsp(int fooXyzzy, int barBaz) { return new LspBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Lsp, 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:
Lsp
,Builder
-
-
Constructor Summary
Constructors Constructor Description LspBuilder()
LspBuilder(Lsp base)
LspBuilder(Object arg)
LspBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LspBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Lsp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>>
E$$augmentation(Class<E$$> augmentationType)
Lsp
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getAdministrative()
Boolean
getDelegate()
Boolean
getIgnore()
OperationalStatus
getOperational()
PlspId
getPlspId()
Boolean
getProcessingRule()
Boolean
getRemove()
Boolean
getSync()
Tlvs
getTlvs()
LspBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> augmentationType)
Remove an augmentation from this builder's product.LspBuilder
setAdministrative(Boolean value)
LspBuilder
setDelegate(Boolean value)
LspBuilder
setIgnore(Boolean value)
LspBuilder
setOperational(OperationalStatus value)
LspBuilder
setPlspId(PlspId value)
LspBuilder
setProcessingRule(Boolean value)
LspBuilder
setRemove(Boolean value)
LspBuilder
setSync(Boolean value)
LspBuilder
setTlvs(Tlvs value)
-
-
-
Constructor Detail
-
LspBuilder
public LspBuilder()
-
LspBuilder
public LspBuilder(Object arg)
-
LspBuilder
public LspBuilder(ObjectHeader arg)
-
LspBuilder
public LspBuilder(Lsp 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:- ObjectHeader
- Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdministrative
public Boolean getAdministrative()
-
getDelegate
public Boolean getDelegate()
-
getIgnore
public Boolean getIgnore()
-
getOperational
public OperationalStatus getOperational()
-
getPlspId
public PlspId getPlspId()
-
getProcessingRule
public Boolean getProcessingRule()
-
getRemove
public Boolean getRemove()
-
getSync
public Boolean getSync()
-
getTlvs
public Tlvs getTlvs()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdministrative
public LspBuilder setAdministrative(Boolean value)
-
setDelegate
public LspBuilder setDelegate(Boolean value)
-
setIgnore
public LspBuilder setIgnore(Boolean value)
-
setOperational
public LspBuilder setOperational(OperationalStatus value)
-
setPlspId
public LspBuilder setPlspId(PlspId value)
-
setProcessingRule
public LspBuilder setProcessingRule(Boolean value)
-
setRemove
public LspBuilder setRemove(Boolean value)
-
setSync
public LspBuilder setSync(Boolean value)
-
setTlvs
public LspBuilder setTlvs(Tlvs value)
-
addAugmentation
public LspBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Lsp> 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 LspBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> 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 Lsp build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Lsp>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Lsp,IllegalArgumentException>
-
-