Class SrpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.srp.object.SrpBuilder
-
@Generated("mdsal-binding-generator") public class SrpBuilder extends Object
Class that buildsSrp
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:
Srp createSrp(int fooXyzzy, int barBaz) { return new SrpBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Srp, 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:
Srp
- 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
-
-
Constructor Summary
Constructors Constructor Description SrpBuilder()
Construct an empty builder.SrpBuilder(Srp base)
Construct a builder initialized with state from specifiedSrp
.SrpBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.SrpBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SrpBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Srp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Srp>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Srp
build()
A newSrp
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.SrpIdNumber
getOperationId()
Return current value associated with the property corresponding toSrp.getOperationId()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Tlvs
getTlvs()
Return current value associated with the property corresponding toSrp.getTlvs()
.SrpBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Srp>> augmentationType)
Remove an augmentation from this builder's product.SrpBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.SrpBuilder
setOperationId(SrpIdNumber value)
Set the property corresponding toSrp.getOperationId()
to the specified value.SrpBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.SrpBuilder
setTlvs(Tlvs value)
Set the property corresponding toSrp.getTlvs()
to the specified value.
-
-
-
Constructor Detail
-
SrpBuilder
public SrpBuilder()
Construct an empty builder.
-
SrpBuilder
public SrpBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
SrpBuilder
public SrpBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
-
Method Detail
-
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
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getOperationId
public SrpIdNumber getOperationId()
Return current value associated with the property corresponding toSrp.getOperationId()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getTlvs
public Tlvs getTlvs()
Return current value associated with the property corresponding toSrp.getTlvs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Srp>> 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
public SrpBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOperationId
public SrpBuilder setOperationId(SrpIdNumber value)
Set the property corresponding toSrp.getOperationId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public SrpBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTlvs
public SrpBuilder setTlvs(Tlvs value)
Set the property corresponding toSrp.getTlvs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SrpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Srp> 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 SrpBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Srp>> 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
-
-