Class OriginalMeterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.service.rev130918.meter.update.OriginalMeterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OriginalMeter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OriginalMeter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class OriginalMeterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OriginalMeter>
Class that buildsOriginalMeterBuilder
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:
OriginalMeterBuilder createTarget(int fooXyzzy, int barBaz) { return new OriginalMeterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OriginalMeterBuilder, 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:
OriginalMeterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OriginalMeterBuilder()
OriginalMeterBuilder(OriginalMeter base)
OriginalMeterBuilder(Meter arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OriginalMeterBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.OriginalMeterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter>>
E$$augmentation(Class<E$$> augmentationType)
OriginalMeter
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()
OriginalMeterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter>> augmentationType)
Remove an augmentation from this builder's product.OriginalMeterBuilder
setBarrier(Boolean value)
OriginalMeterBuilder
setContainerName(String value)
OriginalMeterBuilder
setFlags(MeterFlags value)
OriginalMeterBuilder
setMeterBandHeaders(MeterBandHeaders value)
OriginalMeterBuilder
setMeterId(MeterId value)
OriginalMeterBuilder
setMeterName(String value)
-
-
-
Constructor Detail
-
OriginalMeterBuilder
public OriginalMeterBuilder()
-
OriginalMeterBuilder
public OriginalMeterBuilder(Meter arg)
-
OriginalMeterBuilder
public OriginalMeterBuilder(OriginalMeter 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.meter.types.rev130918.Meter
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
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<OriginalMeter>> E$$ augmentation(Class<E$$> augmentationType)
-
setContainerName
public OriginalMeterBuilder setContainerName(String value)
-
setFlags
public OriginalMeterBuilder setFlags(MeterFlags value)
-
setMeterBandHeaders
public OriginalMeterBuilder setMeterBandHeaders(MeterBandHeaders value)
-
setMeterId
public OriginalMeterBuilder setMeterId(MeterId value)
-
setMeterName
public OriginalMeterBuilder setMeterName(String value)
-
setBarrier
public OriginalMeterBuilder setBarrier(Boolean value)
-
addAugmentation
public OriginalMeterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public OriginalMeterBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public OriginalMeterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginalMeter>> 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 OriginalMeter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OriginalMeter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OriginalMeter,IllegalArgumentException>
-
-