Class BandsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.mod.BandsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Bands>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Bands,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BandsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Bands>
Class that buildsBandsBuilder
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:
BandsBuilder createTarget(int fooXyzzy, int barBaz) { return new BandsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BandsBuilder, 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:
BandsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BandsBuilder()
BandsBuilder(Bands base)
BandsBuilder(MeterBandHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BandsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bands>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Bands> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bands>>
E$$augmentation(Class<E$$> augmentationType)
Bands
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MeterBand
getMeterBand()
BandsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bands>> augmentationType)
BandsBuilder
setMeterBand(MeterBand value)
-
-
-
Constructor Detail
-
BandsBuilder
public BandsBuilder()
-
BandsBuilder
public BandsBuilder(MeterBandHeader arg)
-
BandsBuilder
public BandsBuilder(Bands 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.openflow.protocol.rev130731.MeterBandHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getMeterBand
public MeterBand getMeterBand()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bands>> E$$ augmentation(Class<E$$> augmentationType)
-
setMeterBand
public BandsBuilder setMeterBand(MeterBand value)
-
addAugmentation
public BandsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bands>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Bands> augmentationValue)
-
removeAugmentation
public BandsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bands>> augmentationType)
-
build
public Bands build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Bands>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Bands,IllegalArgumentException>
-
-