Class FsmEventCodeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.down.data.FsmEventCodeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FsmEventCode>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FsmEventCode,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FsmEventCodeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FsmEventCode>
Class that buildsFsmEventCodeBuilder
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:
FsmEventCodeBuilder createTarget(int fooXyzzy, int barBaz) { return new FsmEventCodeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FsmEventCodeBuilder, 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:
FsmEventCodeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FsmEventCodeBuilder()
FsmEventCodeBuilder(FsmEventCode base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FsmEventCodeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FsmEventCode> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FsmEventCode>>
E$$augmentation(Class<E$$> augmentationType)
FsmEventCode
build()
org.opendaylight.yangtools.yang.common.Uint16
getFsmEventCode()
FsmEventCodeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FsmEventCode>> augmentationType)
Remove an augmentation from this builder's product.FsmEventCodeBuilder
setFsmEventCode(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFsmEventCode(Uint16)
instead.FsmEventCodeBuilder
setFsmEventCode(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
FsmEventCodeBuilder
public FsmEventCodeBuilder()
-
FsmEventCodeBuilder
public FsmEventCodeBuilder(FsmEventCode base)
-
-
Method Detail
-
getFsmEventCode
public org.opendaylight.yangtools.yang.common.Uint16 getFsmEventCode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FsmEventCode>> E$$ augmentation(Class<E$$> augmentationType)
-
setFsmEventCode
public FsmEventCodeBuilder setFsmEventCode(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFsmEventCode
@Deprecated(forRemoval=true) public FsmEventCodeBuilder setFsmEventCode(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetFsmEventCode(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public FsmEventCodeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FsmEventCode> 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 FsmEventCodeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FsmEventCode>> 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 FsmEventCode build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FsmEventCode>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FsmEventCode,IllegalArgumentException>
-
-