Class NetworkBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.dhcp_allocation_pool.rev161214.dhcp_allocation_pool.NetworkBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Network>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Network,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NetworkBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Network>
Class that buildsNetworkBuilder
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:
NetworkBuilder createTarget(int fooXyzzy, int barBaz) { return new NetworkBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NetworkBuilder, 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:
NetworkBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NetworkBuilder()
NetworkBuilder(Network base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NetworkBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Network> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Network
build()
java.util.Map<AllocationPoolKey,AllocationPool>
getAllocationPool()
java.util.Map<AllocationsKey,Allocations>
getAllocations()
java.lang.String
getNetworkId()
NetworkKey
key()
NetworkBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> augmentationType)
Remove an augmentation from this builder's product.NetworkBuilder
setAllocationPool(java.util.List<AllocationPool> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllocationPool(Map)
instead.NetworkBuilder
setAllocationPool(java.util.Map<AllocationPoolKey,AllocationPool> values)
NetworkBuilder
setAllocations(java.util.List<Allocations> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllocations(Map)
instead.NetworkBuilder
setAllocations(java.util.Map<AllocationsKey,Allocations> values)
NetworkBuilder
setNetworkId(java.lang.String value)
NetworkBuilder
withKey(NetworkKey key)
-
-
-
Constructor Detail
-
NetworkBuilder
public NetworkBuilder()
-
NetworkBuilder
public NetworkBuilder(Network base)
-
-
Method Detail
-
key
public NetworkKey key()
-
getAllocationPool
public java.util.Map<AllocationPoolKey,AllocationPool> getAllocationPool()
-
getAllocations
public java.util.Map<AllocationsKey,Allocations> getAllocations()
-
getNetworkId
public java.lang.String getNetworkId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public NetworkBuilder withKey(NetworkKey key)
-
setAllocationPool
public NetworkBuilder setAllocationPool(java.util.Map<AllocationPoolKey,AllocationPool> values)
-
setAllocationPool
@Deprecated(forRemoval=true) public NetworkBuilder setAllocationPool(java.util.List<AllocationPool> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllocationPool(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
-
setAllocations
public NetworkBuilder setAllocations(java.util.Map<AllocationsKey,Allocations> values)
-
setAllocations
@Deprecated(forRemoval=true) public NetworkBuilder setAllocations(java.util.List<Allocations> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAllocations(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
-
setNetworkId
public NetworkBuilder setNetworkId(java.lang.String value)
-
addAugmentation
public NetworkBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Network> 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 NetworkBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> 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
-
-