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