Class InterfaceRefBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412._interface.ref.InterfaceRefBuilder
Class that builds
InterfaceRef
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:
InterfaceRef createInterfaceRef(int fooXyzzy, int barBaz) {
return new InterfaceRefBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of InterfaceRef, 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.Construct a builder initialized with state from specifiedInterfaceRef
.Construct a new builder initialized from specifiedInterfaceRefStateContainer
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull InterfaceRef
build()
A newInterfaceRef
instance.static @NonNull InterfaceRef
empty()
Get empty instance of InterfaceRef.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toInterfaceRef.getConfig()
.getState()
Return current value associated with the property corresponding toInterfaceRefStateContainer.getState()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toInterfaceRef.getConfig()
to the specified value.Set the property corresponding toInterfaceRefStateContainer.getState()
to the specified value.
-
Constructor Details
-
InterfaceRefBuilder
public InterfaceRefBuilder()Construct an empty builder. -
InterfaceRefBuilder
Construct a new builder initialized from specifiedInterfaceRefStateContainer
.- Parameters:
arg
- InterfaceRefStateContainer from which the builder should be initialized
-
InterfaceRefBuilder
Construct a builder initialized with state from specifiedInterfaceRef
.- Parameters:
base
- InterfaceRef from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
empty
Get empty instance of InterfaceRef.- Returns:
- An empty
InterfaceRef
-
getConfig
Return current value associated with the property corresponding toInterfaceRef.getConfig()
.- Returns:
- current value
-
getState
Return current value associated with the property corresponding toInterfaceRefStateContainer.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> 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 toInterfaceRef.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
Set the property corresponding toInterfaceRefStateContainer.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public InterfaceRefBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef> 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 InterfaceRefBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceRef>> 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 newInterfaceRef
instance.- Returns:
- A new
InterfaceRef
instance.
-