Class StarttlsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.message.rev181109.StarttlsBuilder
-
@Generated("mdsal-binding-generator") public class StarttlsBuilder extends Object
Class that buildsStarttls
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:
Starttls createStarttls(int fooXyzzy, int barBaz) { return new StarttlsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Starttls, 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:
Starttls
- 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
-
-
Constructor Summary
Constructors Constructor Description StarttlsBuilder()
Construct an empty builder.StarttlsBuilder(Starttls base)
Construct a builder initialized with state from specifiedStarttls
.StarttlsBuilder(Message arg)
Construct a new builder initialized from specifiedMessage
.StarttlsBuilder(StartTlsMessage arg)
Construct a new builder initialized from specifiedStartTlsMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StarttlsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Starttls> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Starttls>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Starttls
build()
A newStarttls
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.StartTlsMessage
getStartTlsMessage()
Return current value associated with the property corresponding toStartTlsMessage.getStartTlsMessage()
.StarttlsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Starttls>> augmentationType)
Remove an augmentation from this builder's product.StarttlsBuilder
setStartTlsMessage(StartTlsMessage value)
Set the property corresponding toStartTlsMessage.getStartTlsMessage()
to the specified value.
-
-
-
Constructor Detail
-
StarttlsBuilder
public StarttlsBuilder()
Construct an empty builder.
-
StarttlsBuilder
public StarttlsBuilder(StartTlsMessage arg)
Construct a new builder initialized from specifiedStartTlsMessage
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.StartTlsMessage from which the builder should be initialized
-
StarttlsBuilder
public StarttlsBuilder(Message arg)
Construct a new builder initialized from specifiedMessage
.- Parameters:
arg
- Message from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getStartTlsMessage
public StartTlsMessage getStartTlsMessage()
Return current value associated with the property corresponding toStartTlsMessage.getStartTlsMessage()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Starttls>> 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
-
setStartTlsMessage
public StarttlsBuilder setStartTlsMessage(StartTlsMessage value)
Set the property corresponding toStartTlsMessage.getStartTlsMessage()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public StarttlsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Starttls> 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 StarttlsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Starttls>> 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
-
-