Class MeteringRuleBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.metering.rev150712.metering.rules.attributes.metering.rules.MeteringRuleBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MeteringRule>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MeteringRule,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MeteringRuleBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MeteringRule>
Class that buildsMeteringRuleBuilder
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:
MeteringRuleBuilder createTarget(int fooXyzzy, int barBaz) { return new MeteringRuleBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MeteringRuleBuilder, 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:
MeteringRuleBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MeteringRuleBuilder()
MeteringRuleBuilder(IdAttributes arg)
MeteringRuleBuilder(MeteringRule base)
MeteringRuleBuilder(MeteringRuleAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MeteringRuleBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeteringRule> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeteringRule>>
E$$augmentation(Class<E$$> augmentationType)
MeteringRule
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends DirectionBase>
getDirection()
Boolean
getExcluded()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getMeteringLabelId()
String
getProjectId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getRemoteIpPrefix()
Long
getRevisionNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
Boolean
isExcluded()
Deprecated, for removal: This API element is subject to removal in a future version.MeteringRuleKey
key()
MeteringRuleBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeteringRule>> augmentationType)
Remove an augmentation from this builder's product.MeteringRuleBuilder
setDirection(Class<? extends DirectionBase> value)
MeteringRuleBuilder
setExcluded(Boolean value)
MeteringRuleBuilder
setMeteringLabelId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
MeteringRuleBuilder
setProjectId(String value)
MeteringRuleBuilder
setRemoteIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
MeteringRuleBuilder
setRevisionNumber(Long value)
MeteringRuleBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
MeteringRuleBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
MeteringRuleBuilder
withKey(MeteringRuleKey key)
-
-
-
Constructor Detail
-
MeteringRuleBuilder
public MeteringRuleBuilder()
-
MeteringRuleBuilder
public MeteringRuleBuilder(IdAttributes arg)
-
MeteringRuleBuilder
public MeteringRuleBuilder(MeteringRuleAttributes arg)
-
MeteringRuleBuilder
public MeteringRuleBuilder(MeteringRule 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.neutron.metering.rev150712.MeteringRuleAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public MeteringRuleKey key()
-
getDirection
public Class<? extends DirectionBase> getDirection()
-
getExcluded
public Boolean getExcluded()
-
isExcluded
@Deprecated(forRemoval=true) public final Boolean isExcluded()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getMeteringLabelId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getMeteringLabelId()
-
getProjectId
public String getProjectId()
-
getRemoteIpPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getRemoteIpPrefix()
-
getRevisionNumber
public Long getRevisionNumber()
-
getTenantId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
-
getUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeteringRule>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public MeteringRuleBuilder withKey(MeteringRuleKey key)
-
setDirection
public MeteringRuleBuilder setDirection(Class<? extends DirectionBase> value)
-
setExcluded
public MeteringRuleBuilder setExcluded(Boolean value)
-
setMeteringLabelId
public MeteringRuleBuilder setMeteringLabelId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setProjectId
public MeteringRuleBuilder setProjectId(String value)
-
setRemoteIpPrefix
public MeteringRuleBuilder setRemoteIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setRevisionNumber
public MeteringRuleBuilder setRevisionNumber(Long value)
-
setTenantId
public MeteringRuleBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public MeteringRuleBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public MeteringRuleBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeteringRule> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MeteringRuleBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeteringRule>> 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 MeteringRule build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MeteringRule>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MeteringRule,IllegalArgumentException>
-
-