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