Class IgpLinkAttributesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.link.attributes.IgpLinkAttributesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IgpLinkAttributes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IgpLinkAttributes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IgpLinkAttributesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IgpLinkAttributes>
Class that buildsIgpLinkAttributesBuilder
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:
IgpLinkAttributesBuilder createTarget(int fooXyzzy, int barBaz) { return new IgpLinkAttributesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IgpLinkAttributesBuilder, 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:
IgpLinkAttributesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IgpLinkAttributesBuilder()
IgpLinkAttributesBuilder(IgpLinkAttributes base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IgpLinkAttributesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>>
E$$augmentation(Class<E$$> augmentationType)
IgpLinkAttributes
build()
List<Class<? extends FlagIdentity>>
getFlag()
org.opendaylight.yangtools.yang.common.Uint32
getMetric()
String
getName()
IgpLinkAttributesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>> augmentationType)
Remove an augmentation from this builder's product.IgpLinkAttributesBuilder
setFlag(List<Class<? extends FlagIdentity>> values)
IgpLinkAttributesBuilder
setMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetric(Uint32)
instead.IgpLinkAttributesBuilder
setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
IgpLinkAttributesBuilder
setName(String value)
-
-
-
Constructor Detail
-
IgpLinkAttributesBuilder
public IgpLinkAttributesBuilder()
-
IgpLinkAttributesBuilder
public IgpLinkAttributesBuilder(IgpLinkAttributes base)
-
-
Method Detail
-
getFlag
public List<Class<? extends FlagIdentity>> getFlag()
-
getMetric
public org.opendaylight.yangtools.yang.common.Uint32 getMetric()
-
getName
public String getName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlag
public IgpLinkAttributesBuilder setFlag(List<Class<? extends FlagIdentity>> values)
-
setMetric
public IgpLinkAttributesBuilder setMetric(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMetric
@Deprecated(forRemoval=true) public IgpLinkAttributesBuilder setMetric(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetric(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setName
public IgpLinkAttributesBuilder setName(String value)
-
addAugmentation
public IgpLinkAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes> 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 IgpLinkAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkAttributes>> 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 IgpLinkAttributes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IgpLinkAttributes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IgpLinkAttributes,IllegalArgumentException>
-
-