Class SwitchFaultStatusBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.physical._switch.attributes.SwitchFaultStatusBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SwitchFaultStatus>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SwitchFaultStatus,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SwitchFaultStatusBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SwitchFaultStatus>
Class that buildsSwitchFaultStatus
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:
SwitchFaultStatus createSwitchFaultStatus(int fooXyzzy, int barBaz) { return new SwitchFaultStatusBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SwitchFaultStatus, 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:
SwitchFaultStatus
,Builder
-
-
Constructor Summary
Constructors Constructor Description SwitchFaultStatusBuilder()
SwitchFaultStatusBuilder(SwitchFaultStatus base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SwitchFaultStatusBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFaultStatus> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFaultStatus>>
E$$augmentation(Class<E$$> augmentationType)
SwitchFaultStatus
build()
String
getSwitchFaultStatusKey()
String
getSwitchFaultStatusValue()
SwitchFaultStatusKey
key()
SwitchFaultStatusBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFaultStatus>> augmentationType)
Remove an augmentation from this builder's product.SwitchFaultStatusBuilder
setSwitchFaultStatusKey(String value)
SwitchFaultStatusBuilder
setSwitchFaultStatusValue(String value)
SwitchFaultStatusBuilder
withKey(SwitchFaultStatusKey key)
-
-
-
Constructor Detail
-
SwitchFaultStatusBuilder
public SwitchFaultStatusBuilder()
-
SwitchFaultStatusBuilder
public SwitchFaultStatusBuilder(SwitchFaultStatus base)
-
-
Method Detail
-
key
public SwitchFaultStatusKey key()
-
getSwitchFaultStatusKey
public String getSwitchFaultStatusKey()
-
getSwitchFaultStatusValue
public String getSwitchFaultStatusValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFaultStatus>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SwitchFaultStatusBuilder withKey(SwitchFaultStatusKey key)
-
setSwitchFaultStatusKey
public SwitchFaultStatusBuilder setSwitchFaultStatusKey(String value)
-
setSwitchFaultStatusValue
public SwitchFaultStatusBuilder setSwitchFaultStatusValue(String value)
-
addAugmentation
public SwitchFaultStatusBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFaultStatus> 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 SwitchFaultStatusBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFaultStatus>> 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 SwitchFaultStatus build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SwitchFaultStatus>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SwitchFaultStatus,IllegalArgumentException>
-
-