Class SubobjectContainerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.record.route.object.secondary.record.route.object.SubobjectContainerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SubobjectContainer>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SubobjectContainer,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SubobjectContainerBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SubobjectContainer>
Class that buildsSubobjectContainerBuilder
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:
SubobjectContainerBuilder createTarget(int fooXyzzy, int barBaz) { return new SubobjectContainerBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubobjectContainerBuilder, 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:
SubobjectContainerBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SubobjectContainerBuilder()
SubobjectContainerBuilder(RecordRouteSubobjects arg)
SubobjectContainerBuilder(SubobjectContainer base)
SubobjectContainerBuilder(SecondaryRecordRouteSubobjects arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubobjectContainerBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>>
E$$augmentation(Class<E$$> augmentationType)
SubobjectContainer
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.SubobjectType
getSubobjectType()
Boolean
isProtectionAvailable()
Boolean
isProtectionInUse()
SubobjectContainerBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> augmentationType)
SubobjectContainerBuilder
setProtectionAvailable(Boolean value)
SubobjectContainerBuilder
setProtectionInUse(Boolean value)
SubobjectContainerBuilder
setSubobjectType(SubobjectType value)
-
-
-
Constructor Detail
-
SubobjectContainerBuilder
public SubobjectContainerBuilder()
-
SubobjectContainerBuilder
public SubobjectContainerBuilder(SecondaryRecordRouteSubobjects arg)
-
SubobjectContainerBuilder
public SubobjectContainerBuilder(RecordRouteSubobjects arg)
-
SubobjectContainerBuilder
public SubobjectContainerBuilder(SubobjectContainer 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.RecordRouteSubobjects
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.SecondaryRecordRouteSubobjects
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getSubobjectType
public SubobjectType getSubobjectType()
-
isProtectionAvailable
public Boolean isProtectionAvailable()
-
isProtectionInUse
public Boolean isProtectionInUse()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> E$$ augmentation(Class<E$$> augmentationType)
-
setSubobjectType
public SubobjectContainerBuilder setSubobjectType(SubobjectType value)
-
setProtectionAvailable
public SubobjectContainerBuilder setProtectionAvailable(Boolean value)
-
setProtectionInUse
public SubobjectContainerBuilder setProtectionInUse(Boolean value)
-
addAugmentation
public SubobjectContainerBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer> augmentationValue)
-
removeAugmentation
public SubobjectContainerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> augmentationType)
-
build
public SubobjectContainer build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SubobjectContainer>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SubobjectContainer,IllegalArgumentException>
-
-