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