Class IfIndexInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._if.indexes._interface.map.IfIndexInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IfIndexInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IfIndexInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IfIndexInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IfIndexInterface>
Class that buildsIfIndexInterfaceBuilder
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:
IfIndexInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new IfIndexInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IfIndexInterfaceBuilder, 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:
IfIndexInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IfIndexInterfaceBuilder()
IfIndexInterfaceBuilder(IfIndexInterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IfIndexInterfaceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexInterface> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IfIndexInterface
build()
java.lang.Integer
getIfIndex()
java.lang.String
getInterfaceName()
IfIndexInterfaceKey
key()
IfIndexInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexInterface>> augmentationType)
Remove an augmentation from this builder's product.IfIndexInterfaceBuilder
setIfIndex(java.lang.Integer value)
IfIndexInterfaceBuilder
setInterfaceName(java.lang.String value)
IfIndexInterfaceBuilder
withKey(IfIndexInterfaceKey key)
-
-
-
Constructor Detail
-
IfIndexInterfaceBuilder
public IfIndexInterfaceBuilder()
-
IfIndexInterfaceBuilder
public IfIndexInterfaceBuilder(IfIndexInterface base)
-
-
Method Detail
-
key
public IfIndexInterfaceKey key()
-
getIfIndex
public java.lang.Integer getIfIndex()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public IfIndexInterfaceBuilder withKey(IfIndexInterfaceKey key)
-
setIfIndex
public IfIndexInterfaceBuilder setIfIndex(java.lang.Integer value)
-
setInterfaceName
public IfIndexInterfaceBuilder setInterfaceName(java.lang.String value)
-
addAugmentation
public IfIndexInterfaceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexInterface> 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
-
removeAugmentation
public IfIndexInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IfIndexInterface>> 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 IfIndexInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IfIndexInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IfIndexInterface,java.lang.IllegalArgumentException>
-
-