Class BasicProtectionObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.protection.object.protection.object.basic.protection.object._case.BasicProtectionObjectBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BasicProtectionObject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BasicProtectionObject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BasicProtectionObjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BasicProtectionObject>
Class that buildsBasicProtectionObjectBuilder
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:
BasicProtectionObjectBuilder createTarget(int fooXyzzy, int barBaz) { return new BasicProtectionObjectBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BasicProtectionObjectBuilder, 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 oportunities, 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:
BasicProtectionObjectBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BasicProtectionObjectBuilder()
BasicProtectionObjectBuilder(BasicProtectionObject base)
BasicProtectionObjectBuilder(ProtectionSubobject arg)
BasicProtectionObjectBuilder(RsvpTeObject arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BasicProtectionObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObject>>
E$$augmentation(Class<E$$> augmentationType)
BasicProtectionObject
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ProtectionSubobject
getProtectionSubobject()
BasicProtectionObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObject>> augmentationType)
Remove an augmentation from this builder's product.BasicProtectionObjectBuilder
setProtectionSubobject(ProtectionSubobject value)
-
-
-
Constructor Detail
-
BasicProtectionObjectBuilder
public BasicProtectionObjectBuilder()
-
BasicProtectionObjectBuilder
public BasicProtectionObjectBuilder(RsvpTeObject arg)
-
BasicProtectionObjectBuilder
public BasicProtectionObjectBuilder(ProtectionSubobject arg)
-
BasicProtectionObjectBuilder
public BasicProtectionObjectBuilder(BasicProtectionObject 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ProtectionSubobject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.RsvpTeObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getProtectionSubobject
public ProtectionSubobject getProtectionSubobject()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObject>> E$$ augmentation(Class<E$$> augmentationType)
-
setProtectionSubobject
public BasicProtectionObjectBuilder setProtectionSubobject(ProtectionSubobject value)
-
addAugmentation
public BasicProtectionObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObject> 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 BasicProtectionObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicProtectionObject>> 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 BasicProtectionObject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BasicProtectionObject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BasicProtectionObject,IllegalArgumentException>
-
-