Class SubinterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.subinterfaces.top.subinterfaces.SubinterfaceBuilder
-
@Generated("mdsal-binding-generator") public class SubinterfaceBuilder extends Object
Class that buildsSubinterface
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:
Subinterface createSubinterface(int fooXyzzy, int barBaz) { return new SubinterfaceBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Subinterface, 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:
Subinterface
- 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
-
-
Constructor Summary
Constructors Constructor Description SubinterfaceBuilder()
Construct an empty builder.SubinterfaceBuilder(Subinterface base)
Construct a builder initialized with state from specifiedSubinterface
.
-
Method Summary
All Methods Instance Methods Concrete 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)
Return the specified augmentation, if it is present in this builder.@NonNull Subinterface
build()
A newSubinterface
instance.Config
getConfig()
Return current value associated with the property corresponding toSubinterface.getConfig()
.org.opendaylight.yangtools.yang.common.Uint32
getIndex()
Return current value associated with the property corresponding toSubinterface.getIndex()
.State
getState()
Return current value associated with the property corresponding toSubinterface.getState()
.SubinterfaceKey
key()
Return current value associated with the property corresponding toSubinterface.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)
Set the property corresponding toSubinterface.getConfig()
to the specified value.SubinterfaceBuilder
setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSubinterface.getIndex()
to the specified value.SubinterfaceBuilder
setState(State value)
Set the property corresponding toSubinterface.getState()
to the specified value.SubinterfaceBuilder
withKey(SubinterfaceKey key)
-
-
-
Constructor Detail
-
SubinterfaceBuilder
public SubinterfaceBuilder()
Construct an empty builder.
-
SubinterfaceBuilder
public SubinterfaceBuilder(Subinterface base)
Construct a builder initialized with state from specifiedSubinterface
.- Parameters:
base
- Subinterface from which the builder should be initialized
-
-
Method Detail
-
key
public SubinterfaceKey key()
Return current value associated with the property corresponding toSubinterface.key()
.- Returns:
- current value
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toSubinterface.getConfig()
.- Returns:
- current value
-
getIndex
public org.opendaylight.yangtools.yang.common.Uint32 getIndex()
Return current value associated with the property corresponding toSubinterface.getIndex()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toSubinterface.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subinterface>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
public SubinterfaceBuilder withKey(SubinterfaceKey key)
-
setConfig
public SubinterfaceBuilder setConfig(Config value)
Set the property corresponding toSubinterface.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIndex
public SubinterfaceBuilder setIndex(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toSubinterface.getIndex()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public SubinterfaceBuilder setState(State value)
Set the property corresponding toSubinterface.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull Subinterface build()
A newSubinterface
instance.- Returns:
- A new
Subinterface
instance.
-
-