Class InterfacesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.InterfacesBuilder
Class that builds
Interfaces
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:
Interfaces createInterfaces(int fooXyzzy, int barBaz) {
return new InterfacesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Interfaces, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.InterfacesBuilder
(Interfaces base) Construct a builder initialized with state from specifiedInterfaces
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Interfaces> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Interfaces>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Interfaces
build()
A newInterfaces
instance.static @NonNull Interfaces
empty()
Get empty instance of Interfaces.Return current value associated with the property corresponding toInterfaces.getConfig()
.getState()
Return current value associated with the property corresponding toInterfaces.getState()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Interfaces>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toInterfaces.getConfig()
to the specified value.Set the property corresponding toInterfaces.getState()
to the specified value.
-
Constructor Details
-
InterfacesBuilder
public InterfacesBuilder()Construct an empty builder. -
InterfacesBuilder
Construct a builder initialized with state from specifiedInterfaces
.- Parameters:
base
- Interfaces from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Interfaces.- Returns:
- An empty
Interfaces
-
getConfig
Return current value associated with the property corresponding toInterfaces.getConfig()
.- Returns:
- current value
-
getState
Return current value associated with the property corresponding toInterfaces.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Interfaces>> 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
-
setConfig
Set the property corresponding toInterfaces.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
Set the property corresponding toInterfaces.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public InterfacesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Interfaces> 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 InterfacesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Interfaces>> 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
A newInterfaces
instance.- Returns:
- A new
Interfaces
instance.
-