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