Class SubinterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.subinterfaces.top.subinterfaces.SubinterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Subinterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Subinterface,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SubinterfaceBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Subinterface>
Class that buildsSubinterfaceBuilder
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:
SubinterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new SubinterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubinterfaceBuilder, 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:
SubinterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SubinterfaceBuilder()
SubinterfaceBuilder(Subinterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SubinterfaceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Subinterface> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subinterface>>
E$$augmentation(Class<E$$> augmentationType)
Subinterface
build()
Config
getConfig()
org.opendaylight.yangtools.yang.common.Uint32
getIndex()
State
getState()
SubinterfaceKey
key()
SubinterfaceBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subinterface>> augmentationType)
Remove an augmentation from this builder's product.SubinterfaceBuilder
setConfig(Config value)
SubinterfaceBuilder
setIndex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIndex(Uint32)
instead.SubinterfaceBuilder
setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
SubinterfaceBuilder
setState(State value)
SubinterfaceBuilder
withKey(SubinterfaceKey key)
-
-
-
Constructor Detail
-
SubinterfaceBuilder
public SubinterfaceBuilder()
-
SubinterfaceBuilder
public SubinterfaceBuilder(Subinterface base)
-
-
Method Detail
-
key
public SubinterfaceKey key()
-
getConfig
public Config getConfig()
-
getIndex
public org.opendaylight.yangtools.yang.common.Uint32 getIndex()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subinterface>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SubinterfaceBuilder withKey(SubinterfaceKey key)
-
setConfig
public SubinterfaceBuilder setConfig(Config value)
-
setIndex
public SubinterfaceBuilder setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setIndex
@Deprecated(forRemoval=true) public SubinterfaceBuilder setIndex(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIndex(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setState
public SubinterfaceBuilder setState(State value)
-
addAugmentation
public SubinterfaceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Subinterface> 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 SubinterfaceBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subinterface>> 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 Subinterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Subinterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Subinterface,IllegalArgumentException>
-
-