Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.link.attributes
Class OspfLinkAttributesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.link.attributes.OspfLinkAttributesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OspfLinkAttributes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OspfLinkAttributes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OspfLinkAttributesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OspfLinkAttributes>
Class that buildsOspfLinkAttributesBuilder
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:
OspfLinkAttributesBuilder createTarget(int fooXyzzy, int barBaz) { return new OspfLinkAttributesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OspfLinkAttributesBuilder, 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:
OspfLinkAttributesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OspfLinkAttributesBuilder()
OspfLinkAttributesBuilder(OspfLinkAttributes base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OspfLinkAttributesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfLinkAttributes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfLinkAttributes>>
E$$augmentation(Class<E$$> augmentationType)
OspfLinkAttributes
build()
org.opendaylight.yangtools.yang.common.Uint8
getMultiTopologyId()
Ted
getTed()
OspfLinkAttributesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfLinkAttributes>> augmentationType)
Remove an augmentation from this builder's product.OspfLinkAttributesBuilder
setMultiTopologyId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMultiTopologyId(Uint8)
instead.OspfLinkAttributesBuilder
setMultiTopologyId(org.opendaylight.yangtools.yang.common.Uint8 value)
OspfLinkAttributesBuilder
setTed(Ted value)
-
-
-
Constructor Detail
-
OspfLinkAttributesBuilder
public OspfLinkAttributesBuilder()
-
OspfLinkAttributesBuilder
public OspfLinkAttributesBuilder(OspfLinkAttributes base)
-
-
Method Detail
-
getMultiTopologyId
public org.opendaylight.yangtools.yang.common.Uint8 getMultiTopologyId()
-
getTed
public Ted getTed()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfLinkAttributes>> E$$ augmentation(Class<E$$> augmentationType)
-
setMultiTopologyId
public OspfLinkAttributesBuilder setMultiTopologyId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMultiTopologyId
@Deprecated(forRemoval=true) public OspfLinkAttributesBuilder setMultiTopologyId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMultiTopologyId(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTed
public OspfLinkAttributesBuilder setTed(Ted value)
-
addAugmentation
public OspfLinkAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OspfLinkAttributes> 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 OspfLinkAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OspfLinkAttributes>> 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 OspfLinkAttributes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OspfLinkAttributes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OspfLinkAttributes,IllegalArgumentException>
-
-