Class SubobjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.exclude.route.object.xro.SubobjectBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Subobject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Subobject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SubobjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Subobject>
Class that buildsSubobjectBuilder
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:
SubobjectBuilder createTarget(int fooXyzzy, int barBaz) { return new SubobjectBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubobjectBuilder, 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:
SubobjectBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SubobjectBuilder()
SubobjectBuilder(Subobject base)
SubobjectBuilder(BasicExplicitRouteSubobjects arg)
SubobjectBuilder(ExcludeRouteSubobjects arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SubobjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Subobject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobject>>
E$$augmentation(Class<E$$> augmentationType)
Subobject
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExcludeRouteSubobjects.Attribute
getAttribute()
Boolean
getMandatory()
SubobjectType
getSubobjectType()
Boolean
isMandatory()
Deprecated, for removal: This API element is subject to removal in a future version.SubobjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobject>> augmentationType)
Remove an augmentation from this builder's product.SubobjectBuilder
setAttribute(ExcludeRouteSubobjects.Attribute value)
SubobjectBuilder
setMandatory(Boolean value)
SubobjectBuilder
setSubobjectType(SubobjectType value)
-
-
-
Constructor Detail
-
SubobjectBuilder
public SubobjectBuilder()
-
SubobjectBuilder
public SubobjectBuilder(ExcludeRouteSubobjects arg)
-
SubobjectBuilder
public SubobjectBuilder(BasicExplicitRouteSubobjects arg)
-
SubobjectBuilder
public SubobjectBuilder(Subobject 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.BasicExplicitRouteSubobjects
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ExcludeRouteSubobjects
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAttribute
public ExcludeRouteSubobjects.Attribute getAttribute()
-
getMandatory
public Boolean getMandatory()
-
isMandatory
@Deprecated(forRemoval=true) public final Boolean isMandatory()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSubobjectType
public SubobjectType getSubobjectType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobject>> E$$ augmentation(Class<E$$> augmentationType)
-
setAttribute
public SubobjectBuilder setAttribute(ExcludeRouteSubobjects.Attribute value)
-
setMandatory
public SubobjectBuilder setMandatory(Boolean value)
-
setSubobjectType
public SubobjectBuilder setSubobjectType(SubobjectType value)
-
addAugmentation
public SubobjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Subobject> 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 SubobjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobject>> 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 Subobject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Subobject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Subobject,IllegalArgumentException>
-
-