Class MeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.meters.MeterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Meter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Meter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MeterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Meter>
Class that buildsMeterBuilder
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:
MeterBuilder createTarget(int fooXyzzy, int barBaz) { return new MeterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeterBuilder, 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:
MeterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeterBuilder()
MeterBuilder(Meter base)
MeterBuilder(Meter arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MeterBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Meter> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>>
E$$augmentation(Class<E$$> augmentationType)
Meter
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getContainerName()
MeterFlags
getFlags()
MeterBandHeaders
getMeterBandHeaders()
MeterId
getMeterId()
String
getMeterName()
Boolean
isBarrier()
MeterKey
key()
MeterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> augmentationType)
MeterBuilder
setBarrier(Boolean value)
MeterBuilder
setContainerName(String value)
MeterBuilder
setFlags(MeterFlags value)
MeterBuilder
setMeterBandHeaders(MeterBandHeaders value)
MeterBuilder
setMeterId(MeterId value)
MeterBuilder
setMeterName(String value)
MeterBuilder
withKey(MeterKey key)
-
-
-
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.meter.types.rev130918.Meter
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public MeterKey key()
-
getContainerName
public String getContainerName()
-
getFlags
public MeterFlags getFlags()
-
getMeterBandHeaders
public MeterBandHeaders getMeterBandHeaders()
-
getMeterId
public MeterId getMeterId()
-
getMeterName
public String getMeterName()
-
isBarrier
public Boolean isBarrier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public MeterBuilder withKey(MeterKey key)
-
setContainerName
public MeterBuilder setContainerName(String value)
-
setFlags
public MeterBuilder setFlags(MeterFlags value)
-
setMeterBandHeaders
public MeterBuilder setMeterBandHeaders(MeterBandHeaders value)
-
setMeterId
public MeterBuilder setMeterId(MeterId value)
-
setMeterName
public MeterBuilder setMeterName(String value)
-
setBarrier
public MeterBuilder setBarrier(Boolean value)
-
addAugmentation
public MeterBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Meter> augmentationValue)
-
removeAugmentation
public MeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Meter>> augmentationType)
-
build
public Meter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Meter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Meter,IllegalArgumentException>
-
-