Class BandwidthUsageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.auto.bandwidth.rev181109.bandwidth.usage.object.BandwidthUsageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BandwidthUsage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BandwidthUsage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BandwidthUsageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BandwidthUsage>
Class that buildsBandwidthUsageBuilder
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:
BandwidthUsageBuilder createTarget(int fooXyzzy, int barBaz) { return new BandwidthUsageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BandwidthUsageBuilder, 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:
BandwidthUsageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BandwidthUsageBuilder()
BandwidthUsageBuilder(BandwidthUsage base)
BandwidthUsageBuilder(BwSamples arg)
BandwidthUsageBuilder(Object arg)
BandwidthUsageBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BandwidthUsageBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>>
E$$augmentation(Class<E$$> augmentationType)
BandwidthUsage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Bandwidth>
getBwSample()
Boolean
isIgnore()
Boolean
isProcessingRule()
BandwidthUsageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> augmentationType)
BandwidthUsageBuilder
setBwSample(List<Bandwidth> values)
BandwidthUsageBuilder
setIgnore(Boolean value)
BandwidthUsageBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
BandwidthUsageBuilder
public BandwidthUsageBuilder()
-
BandwidthUsageBuilder
public BandwidthUsageBuilder(Object arg)
-
BandwidthUsageBuilder
public BandwidthUsageBuilder(ObjectHeader arg)
-
BandwidthUsageBuilder
public BandwidthUsageBuilder(BwSamples arg)
-
BandwidthUsageBuilder
public BandwidthUsageBuilder(BandwidthUsage 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.controller.pcep.auto.bandwidth.rev181109.BwSamples
- 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
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> E$$ augmentation(Class<E$$> augmentationType)
-
setBwSample
public BandwidthUsageBuilder setBwSample(List<Bandwidth> values)
-
setIgnore
public BandwidthUsageBuilder setIgnore(Boolean value)
-
setProcessingRule
public BandwidthUsageBuilder setProcessingRule(Boolean value)
-
addAugmentation
public BandwidthUsageBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage> augmentationValue)
-
removeAugmentation
public BandwidthUsageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BandwidthUsage>> augmentationType)
-
build
public BandwidthUsage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BandwidthUsage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BandwidthUsage,IllegalArgumentException>
-
-