Class ExplicitRouteObjectBuilder
java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<ExplicitRouteObject,ExplicitRouteObjectBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.explicit.route.object.ExplicitRouteObjectBuilder
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator")
public class ExplicitRouteObjectBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<ExplicitRouteObject,ExplicitRouteObjectBuilder>
Class that builds
ExplicitRouteObject 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:
ExplicitRouteObject createExplicitRouteObject(int fooXyzzy, int barBaz) {
return new ExplicitRouteObjectBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ExplicitRouteObject, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedExplicitRouteObject.Construct a new builder initialized from specifiedExplicitRouteSubobjectsList. -
Method Summary
Modifier and TypeMethodDescription@NonNull ExplicitRouteObjectbuild()Returns A newExplicitRouteObjectinstance.static @NonNull ExplicitRouteObjectempty()Returns an emptyExplicitRouteObject.voidfieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasesetSubobjectContainer(List<SubobjectContainer> values) Set the property corresponding toExplicitRouteSubobjectsList.getSubobjectContainer()to the specified value.Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder
addAugmentation, augmentation, augmentations, removeAugmentation
-
Constructor Details
-
ExplicitRouteObjectBuilder
public ExplicitRouteObjectBuilder()Construct an empty builder. -
ExplicitRouteObjectBuilder
Construct a new builder initialized from specifiedExplicitRouteSubobjectsList.- Parameters:
arg- ExplicitRouteSubobjectsList from which the builder should be initialized
-
ExplicitRouteObjectBuilder
Construct a builder initialized with state from specifiedExplicitRouteObject.- Parameters:
base- ExplicitRouteObject from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
Returns an emptyExplicitRouteObject.- Returns:
- an empty
ExplicitRouteObject
-
getSubobjectContainer
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toExplicitRouteSubobjectsList.getSubobjectContainer().- Returns:
- current value
-
setSubobjectContainer
Set the property corresponding toExplicitRouteSubobjectsList.getSubobjectContainer()to the specified value.- Parameters:
values- desired value- Returns:
- this builder
-
build
Returns A newExplicitRouteObjectinstance.- Returns:
- A new
ExplicitRouteObjectinstance
-