Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.message
Class OpenMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.open.message.OpenMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OpenMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OpenMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OpenMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OpenMessage>
Class that buildsOpenMessageBuilder
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:
OpenMessageBuilder createTarget(int fooXyzzy, int barBaz) { return new OpenMessageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OpenMessageBuilder, 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:
OpenMessageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OpenMessageBuilder()
OpenMessageBuilder(MessageHeader arg)
OpenMessageBuilder(OpenMessage base)
OpenMessageBuilder(OpenObject arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OpenMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>>
E$$augmentation(Class<E$$> augmentationType)
OpenMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Open
getOpen()
ProtocolVersion
getVersion()
OpenMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>> augmentationType)
Remove an augmentation from this builder's product.OpenMessageBuilder
setOpen(Open value)
OpenMessageBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
OpenMessageBuilder
public OpenMessageBuilder()
-
OpenMessageBuilder
public OpenMessageBuilder(MessageHeader arg)
-
OpenMessageBuilder
public OpenMessageBuilder(OpenObject arg)
-
OpenMessageBuilder
public OpenMessageBuilder(OpenMessage 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.OpenObject
- 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 or has property with incompatible value
-
getOpen
public Open getOpen()
-
getVersion
public ProtocolVersion getVersion()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setOpen
public OpenMessageBuilder setOpen(Open value)
-
setVersion
public OpenMessageBuilder setVersion(ProtocolVersion value)
-
addAugmentation
public OpenMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage> 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 OpenMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OpenMessage>> 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 OpenMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OpenMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OpenMessage,IllegalArgumentException>
-
-