Class DscpmarkingRulesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.qos.policy.DscpmarkingRulesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DscpmarkingRules>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DscpmarkingRules,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DscpmarkingRulesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<DscpmarkingRules>
Class that buildsDscpmarkingRulesBuilder
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:
DscpmarkingRulesBuilder createTarget(int fooXyzzy, int barBaz) { return new DscpmarkingRulesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DscpmarkingRulesBuilder, 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:
DscpmarkingRulesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DscpmarkingRulesBuilder()
DscpmarkingRulesBuilder(IdAttributes arg)
DscpmarkingRulesBuilder(DscpmarkingRuleAttributes arg)
DscpmarkingRulesBuilder(DscpmarkingRules base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DscpmarkingRulesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DscpmarkingRulesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules>>
E$$augmentation(Class<E$$> augmentationType)
DscpmarkingRules
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getDscpMark()
String
getProjectId()
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()
DscpmarkingRulesKey
key()
DscpmarkingRulesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules>> augmentationType)
Remove an augmentation from this builder's product.DscpmarkingRulesBuilder
setDscpMark(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDscpMark(Uint8)
instead.DscpmarkingRulesBuilder
setDscpMark(org.opendaylight.yangtools.yang.common.Uint8 value)
DscpmarkingRulesBuilder
setProjectId(String value)
DscpmarkingRulesBuilder
setRevisionNumber(Long value)
DscpmarkingRulesBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
DscpmarkingRulesBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
DscpmarkingRulesBuilder
withKey(DscpmarkingRulesKey key)
-
-
-
Constructor Detail
-
DscpmarkingRulesBuilder
public DscpmarkingRulesBuilder()
-
DscpmarkingRulesBuilder
public DscpmarkingRulesBuilder(IdAttributes arg)
-
DscpmarkingRulesBuilder
public DscpmarkingRulesBuilder(DscpmarkingRuleAttributes arg)
-
DscpmarkingRulesBuilder
public DscpmarkingRulesBuilder(DscpmarkingRules 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.qos.rev160613.DscpmarkingRuleAttributes
- 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
-
key
public DscpmarkingRulesKey key()
-
getDscpMark
public org.opendaylight.yangtools.yang.common.Uint8 getDscpMark()
-
getProjectId
public String getProjectId()
-
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<DscpmarkingRules>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public DscpmarkingRulesBuilder withKey(DscpmarkingRulesKey key)
-
setDscpMark
public DscpmarkingRulesBuilder setDscpMark(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setDscpMark
@Deprecated(forRemoval=true) public DscpmarkingRulesBuilder setDscpMark(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDscpMark(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setProjectId
public DscpmarkingRulesBuilder setProjectId(String value)
-
setRevisionNumber
public DscpmarkingRulesBuilder setRevisionNumber(Long value)
-
setTenantId
public DscpmarkingRulesBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public DscpmarkingRulesBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public DscpmarkingRulesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules> 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 DscpmarkingRulesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules> 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 DscpmarkingRulesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpmarkingRules>> 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 DscpmarkingRules build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DscpmarkingRules>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DscpmarkingRules,IllegalArgumentException>
-
-