Class StartTlsMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.start.tls.message.StartTlsMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<StartTlsMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<StartTlsMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class StartTlsMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<StartTlsMessage>
Class that buildsStartTlsMessageBuilder
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:
StartTlsMessageBuilder createTarget(int fooXyzzy, int barBaz) { return new StartTlsMessageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StartTlsMessageBuilder, 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 oportunities, 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:
StartTlsMessageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description StartTlsMessageBuilder()
StartTlsMessageBuilder(MessageHeader arg)
StartTlsMessageBuilder(StartTlsMessage base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description StartTlsMessageBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.StartTlsMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage>>
E$$augmentation(Class<E$$> augmentationType)
StartTlsMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ProtocolVersion
getVersion()
StartTlsMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage>> augmentationType)
Remove an augmentation from this builder's product.StartTlsMessageBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
StartTlsMessageBuilder
public StartTlsMessageBuilder()
-
StartTlsMessageBuilder
public StartTlsMessageBuilder(MessageHeader arg)
-
StartTlsMessageBuilder
public StartTlsMessageBuilder(StartTlsMessage 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.MessageHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getVersion
public ProtocolVersion getVersion()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setVersion
public StartTlsMessageBuilder setVersion(ProtocolVersion value)
-
addAugmentation
public StartTlsMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public StartTlsMessageBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public StartTlsMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StartTlsMessage>> 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 StartTlsMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<StartTlsMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<StartTlsMessage,IllegalArgumentException>
-
-