Class SendNeighborSolicitationInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210.SendNeighborSolicitationInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SendNeighborSolicitationInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SendNeighborSolicitationInput,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SendNeighborSolicitationInputBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<SendNeighborSolicitationInput>
Class that buildsSendNeighborSolicitationInputBuilder
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:
SendNeighborSolicitationInputBuilder createTarget(int fooXyzzy, int barBaz) { return new SendNeighborSolicitationInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SendNeighborSolicitationInputBuilder, 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:
SendNeighborSolicitationInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SendNeighborSolicitationInputBuilder()
SendNeighborSolicitationInputBuilder(Interfaces arg)
SendNeighborSolicitationInputBuilder(SendNeighborSolicitationInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SendNeighborSolicitationInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SendNeighborSolicitationInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SendNeighborSolicitationInput>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
SendNeighborSolicitationInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.util.Map<InterfaceAddressKey,InterfaceAddress>
getInterfaceAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
getTargetIpAddress()
SendNeighborSolicitationInputBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SendNeighborSolicitationInput>> augmentationType)
Remove an augmentation from this builder's product.SendNeighborSolicitationInputBuilder
setInterfaceAddress(java.util.List<InterfaceAddress> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceAddress(Map)
instead.SendNeighborSolicitationInputBuilder
setInterfaceAddress(java.util.Map<InterfaceAddressKey,InterfaceAddress> values)
SendNeighborSolicitationInputBuilder
setTargetIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
-
-
-
Constructor Detail
-
SendNeighborSolicitationInputBuilder
public SendNeighborSolicitationInputBuilder()
-
SendNeighborSolicitationInputBuilder
public SendNeighborSolicitationInputBuilder(Interfaces arg)
-
SendNeighborSolicitationInputBuilder
public SendNeighborSolicitationInputBuilder(SendNeighborSolicitationInput 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.genius.ipv6.nd.util.rev170210.Interfaces
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getInterfaceAddress
public java.util.Map<InterfaceAddressKey,InterfaceAddress> getInterfaceAddress()
-
getTargetIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getTargetIpAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SendNeighborSolicitationInput>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setInterfaceAddress
public SendNeighborSolicitationInputBuilder setInterfaceAddress(java.util.Map<InterfaceAddressKey,InterfaceAddress> values)
-
setInterfaceAddress
@Deprecated(forRemoval=true) public SendNeighborSolicitationInputBuilder setInterfaceAddress(java.util.List<InterfaceAddress> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceAddress(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setTargetIpAddress
public SendNeighborSolicitationInputBuilder setTargetIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
-
addAugmentation
public SendNeighborSolicitationInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SendNeighborSolicitationInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public SendNeighborSolicitationInputBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SendNeighborSolicitationInput>> 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 SendNeighborSolicitationInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SendNeighborSolicitationInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SendNeighborSolicitationInput,java.lang.IllegalArgumentException>
-
-