Class SeroBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.secondary.explicit.route.object.SeroBuilder
Class that builds
Sero
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:
Sero createSero(int fooXyzzy, int barBaz) {
return new SeroBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Sero, 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.SeroBuilder
(ObjectHeader arg) Construct a new builder initialized from specifiedObjectHeader
.SeroBuilder
(Sero base) Construct a builder initialized with state from specifiedSero
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Sero> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Sero>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Sero
build()
A newSero
instance.static @NonNull Sero
empty()
Get empty instance of Sero.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Return current value associated with the property corresponding toSero.getSubobject()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Sero>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toObjectHeader.getIgnore()
to the specified value.setProcessingRule
(Boolean value) Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.setSubobject
(List<Subobject> values) Set the property corresponding toSero.getSubobject()
to the specified value.
-
Constructor Details
-
SeroBuilder
public SeroBuilder()Construct an empty builder. -
SeroBuilder
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
SeroBuilder
Construct a builder initialized with state from specifiedSero
.- Parameters:
base
- Sero 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
Get empty instance of Sero.- Returns:
- An empty
Sero
-
getIgnore
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getProcessingRule
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getSubobject
Return current value associated with the property corresponding toSero.getSubobject()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Sero>> 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
-
setIgnore
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSubobject
Set the property corresponding toSero.getSubobject()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SeroBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Sero> 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 SeroBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Sero>> 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 newSero
instance.- Returns:
- A new
Sero
instance.
-