Class InterfaceStateChangeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.InterfaceStateChangeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InterfaceStateChange>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceStateChange,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class InterfaceStateChangeBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<InterfaceStateChange>
Class that buildsInterfaceStateChangeBuilder
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:
InterfaceStateChangeBuilder createTarget(int fooXyzzy, int barBaz) { return new InterfaceStateChangeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceStateChangeBuilder, 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:
InterfaceStateChangeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceStateChangeBuilder()
InterfaceStateChangeBuilder(InterfaceStateChange base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InterfaceStateChangeBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.InterfaceStateChangeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
InterfaceStateChange
build()
InterfaceStatus
getAdminStatus()
InterfaceNameOrIndex
getName()
InterfaceStatus
getOperStatus()
InterfaceStateChangeBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange>> augmentationType)
Remove an augmentation from this builder's product.InterfaceStateChangeBuilder
setAdminStatus(InterfaceStatus value)
InterfaceStateChangeBuilder
setName(InterfaceNameOrIndex value)
InterfaceStateChangeBuilder
setOperStatus(InterfaceStatus value)
-
-
-
Constructor Detail
-
InterfaceStateChangeBuilder
public InterfaceStateChangeBuilder()
-
InterfaceStateChangeBuilder
public InterfaceStateChangeBuilder(InterfaceStateChange base)
-
-
Method Detail
-
getAdminStatus
public InterfaceStatus getAdminStatus()
-
getName
public InterfaceNameOrIndex getName()
-
getOperStatus
public InterfaceStatus getOperStatus()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setAdminStatus
public InterfaceStateChangeBuilder setAdminStatus(InterfaceStatus value)
-
setName
public InterfaceStateChangeBuilder setName(InterfaceNameOrIndex value)
-
setOperStatus
public InterfaceStateChangeBuilder setOperStatus(InterfaceStatus value)
-
addAugmentation
public InterfaceStateChangeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public InterfaceStateChangeBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public InterfaceStateChangeBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceStateChange>> 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 InterfaceStateChange build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InterfaceStateChange>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceStateChange,java.lang.IllegalArgumentException>
-
-