Class XroBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.exclude.route.object.XroBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Xro>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Xro,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class XroBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Xro>
Class that buildsXroBuilder
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:
XroBuilder createTarget(int fooXyzzy, int barBaz) { return new XroBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of XroBuilder, 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:
XroBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description XroBuilder()
XroBuilder(Xro base)
XroBuilder(Object arg)
XroBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XroBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Xro>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Xro> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Xro>>
E$$augmentation(Class<E$$> augmentationType)
Xro
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Xro.Flags
getFlags()
List<Subobject>
getSubobject()
Boolean
isIgnore()
Boolean
isProcessingRule()
XroBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Xro>> augmentationType)
XroBuilder
setFlags(Xro.Flags value)
XroBuilder
setIgnore(Boolean value)
XroBuilder
setProcessingRule(Boolean value)
XroBuilder
setSubobject(List<Subobject> values)
-
-
-
Constructor Detail
-
XroBuilder
public XroBuilder()
-
XroBuilder
public XroBuilder(Object arg)
-
XroBuilder
public XroBuilder(ObjectHeader arg)
-
XroBuilder
public XroBuilder(Xro 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.pcep.types.rev181109.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getFlags
public Xro.Flags getFlags()
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Xro>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlags
public XroBuilder setFlags(Xro.Flags value)
-
setSubobject
public XroBuilder setSubobject(List<Subobject> values)
-
setIgnore
public XroBuilder setIgnore(Boolean value)
-
setProcessingRule
public XroBuilder setProcessingRule(Boolean value)
-
addAugmentation
public XroBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Xro>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Xro> augmentationValue)
-
removeAugmentation
public XroBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Xro>> augmentationType)
-
build
public Xro build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Xro>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Xro,IllegalArgumentException>
-
-