Class LspIdentifiersBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.lsp.identifiers.tlv.LspIdentifiersBuilder
Class that builds
LspIdentifiers
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedLspIdentifiers
.LspIdentifiersBuilder
(Tlv arg) Construct a new builder initialized from specifiedTlv
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull LspIdentifiers
build()
A newLspIdentifiers
instance.static @NonNull LspIdentifiers
empty()
Get empty instance of LspIdentifiers.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLspIdentifiers.getAddressFamily()
.getLspId()
Return current value associated with the property corresponding toLspIdentifiers.getLspId()
.Return current value associated with the property corresponding toLspIdentifiers.getTunnelId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers>> augmentationType) Remove an augmentation from this builder's product.setAddressFamily
(AddressFamily value) Set the property corresponding toLspIdentifiers.getAddressFamily()
to the specified value.Set the property corresponding toLspIdentifiers.getLspId()
to the specified value.setTunnelId
(TunnelId value) Set the property corresponding toLspIdentifiers.getTunnelId()
to the specified value.
-
Constructor Details
-
LspIdentifiersBuilder
public LspIdentifiersBuilder()Construct an empty builder. -
LspIdentifiersBuilder
Construct a new builder initialized from specifiedTlv
.- Parameters:
arg
- Tlv from which the builder should be initialized
-
LspIdentifiersBuilder
Construct a builder initialized with state from specifiedLspIdentifiers
.- Parameters:
base
- LspIdentifiers 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 LspIdentifiers.- Returns:
- An empty
LspIdentifiers
-
getAddressFamily
Return current value associated with the property corresponding toLspIdentifiers.getAddressFamily()
.- Returns:
- current value
-
getLspId
Return current value associated with the property corresponding toLspIdentifiers.getLspId()
.- Returns:
- current value
-
getTunnelId
Return current value associated with the property corresponding toLspIdentifiers.getTunnelId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LspIdentifiers>> 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
-
setAddressFamily
Set the property corresponding toLspIdentifiers.getAddressFamily()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspId
Set the property corresponding toLspIdentifiers.getLspId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTunnelId
Set the property corresponding toLspIdentifiers.getTunnelId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
A newLspIdentifiers
instance.- Returns:
- A new
LspIdentifiers
instance.
-