Class LspBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.object.LspBuilder
Class that builds
Lsp
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.LspBuilder
(Lsp base) Construct a builder initialized with state from specifiedLsp
.LspBuilder
(Object arg) Construct a new builder initialized from specifiedObject
.LspBuilder
(ObjectHeader arg) Construct a new builder initialized from specifiedObjectHeader
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull Lsp
build()
A newLsp
instance.static @NonNull Lsp
empty()
Get empty instance of Lsp.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLsp.getAdministrative()
.Return current value associated with the property corresponding toLsp.getDelegate()
.Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Return current value associated with the property corresponding toLsp.getOperational()
.Return current value associated with the property corresponding toLsp.getPlspId()
.Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Return current value associated with the property corresponding toLsp.getRemove()
.getSync()
Return current value associated with the property corresponding toLsp.getSync()
.getTlvs()
Return current value associated with the property corresponding toLsp.getTlvs()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> augmentationType) Remove an augmentation from this builder's product.setAdministrative
(Boolean value) Set the property corresponding toLsp.getAdministrative()
to the specified value.setDelegate
(Boolean value) Set the property corresponding toLsp.getDelegate()
to the specified value.Set the property corresponding toObjectHeader.getIgnore()
to the specified value.setOperational
(OperationalStatus value) Set the property corresponding toLsp.getOperational()
to the specified value.Set the property corresponding toLsp.getPlspId()
to the specified value.setProcessingRule
(Boolean value) Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.Set the property corresponding toLsp.getRemove()
to the specified value.Set the property corresponding toLsp.getSync()
to the specified value.Set the property corresponding toLsp.getTlvs()
to the specified value.
-
Constructor Details
-
LspBuilder
public LspBuilder()Construct an empty builder. -
LspBuilder
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
LspBuilder
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
LspBuilder
Construct a builder initialized with state from specifiedLsp
.- Parameters:
base
- Lsp from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
empty
Get empty instance of Lsp.- Returns:
- An empty
Lsp
-
getAdministrative
Return current value associated with the property corresponding toLsp.getAdministrative()
.- Returns:
- current value
-
getDelegate
Return current value associated with the property corresponding toLsp.getDelegate()
.- Returns:
- current value
-
getIgnore
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getOperational
Return current value associated with the property corresponding toLsp.getOperational()
.- Returns:
- current value
-
getPlspId
Return current value associated with the property corresponding toLsp.getPlspId()
.- Returns:
- current value
-
getProcessingRule
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getRemove
Return current value associated with the property corresponding toLsp.getRemove()
.- Returns:
- current value
-
getSync
Return current value associated with the property corresponding toLsp.getSync()
.- Returns:
- current value
-
getTlvs
Return current value associated with the property corresponding toLsp.getTlvs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Lsp>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setAdministrative
Set the property corresponding toLsp.getAdministrative()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDelegate
Set the property corresponding toLsp.getDelegate()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOperational
Set the property corresponding toLsp.getOperational()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPlspId
Set the property corresponding toLsp.getPlspId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemove
Set the property corresponding toLsp.getRemove()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSync
Set the property corresponding toLsp.getSync()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTlvs
Set the property corresponding toLsp.getTlvs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
A newLsp
instance.- Returns:
- A new
Lsp
instance.
-