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