Class SrpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.srp.object.SrpBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Srp>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Srp,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SrpBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Srp>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description SrpBuilder()
SrpBuilder(Srp base)
SrpBuilder(Object arg)
SrpBuilder(ObjectHeader arg)
-
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)
Srp
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
SrpIdNumber
getOperationId()
Boolean
getProcessingRule()
Tlvs
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)
SrpBuilder
setOperationId(SrpIdNumber value)
SrpBuilder
setProcessingRule(Boolean value)
SrpBuilder
setTlvs(Tlvs value)
-
-
-
Constructor Detail
-
SrpBuilder
public SrpBuilder()
-
SrpBuilder
public SrpBuilder(Object arg)
-
SrpBuilder
public SrpBuilder(ObjectHeader arg)
-
SrpBuilder
public SrpBuilder(Srp base)
-
-
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:- ObjectHeader
- Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIgnore
public Boolean getIgnore()
-
getOperationId
public SrpIdNumber getOperationId()
-
getProcessingRule
public Boolean getProcessingRule()
-
getTlvs
public Tlvs getTlvs()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Srp>> E$$ augmentation(Class<E$$> augmentationType)
-
setIgnore
public SrpBuilder setIgnore(Boolean value)
-
setOperationId
public SrpBuilder setOperationId(SrpIdNumber value)
-
setProcessingRule
public SrpBuilder setProcessingRule(Boolean value)
-
setTlvs
public SrpBuilder setTlvs(Tlvs value)
-
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
-
build
public Srp build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Srp>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Srp,IllegalArgumentException>
-
-