Class DpnToInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.dpn.to._interface.list.DpnToInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DpnToInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DpnToInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DpnToInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<DpnToInterface>
Class that buildsDpnToInterfaceBuilder
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:
DpnToInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new DpnToInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DpnToInterfaceBuilder, 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:
DpnToInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DpnToInterfaceBuilder()
DpnToInterfaceBuilder(DpnToInterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DpnToInterfaceBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DpnToInterfaceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
DpnToInterface
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpid()
java.util.Map<InterfaceNameEntryKey,InterfaceNameEntry>
getInterfaceNameEntry()
DpnToInterfaceKey
key()
DpnToInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface>> augmentationType)
Remove an augmentation from this builder's product.DpnToInterfaceBuilder
setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.DpnToInterfaceBuilder
setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
DpnToInterfaceBuilder
setInterfaceNameEntry(java.util.List<InterfaceNameEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceNameEntry(Map)
instead.DpnToInterfaceBuilder
setInterfaceNameEntry(java.util.Map<InterfaceNameEntryKey,InterfaceNameEntry> values)
DpnToInterfaceBuilder
withKey(DpnToInterfaceKey key)
-
-
-
Constructor Detail
-
DpnToInterfaceBuilder
public DpnToInterfaceBuilder()
-
DpnToInterfaceBuilder
public DpnToInterfaceBuilder(DpnToInterface base)
-
-
Method Detail
-
key
public DpnToInterfaceKey key()
-
getDpid
public org.opendaylight.yangtools.yang.common.Uint64 getDpid()
-
getInterfaceNameEntry
public java.util.Map<InterfaceNameEntryKey,InterfaceNameEntry> getInterfaceNameEntry()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public DpnToInterfaceBuilder withKey(DpnToInterfaceKey key)
-
setDpid
public DpnToInterfaceBuilder setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpid
@Deprecated(forRemoval=true) public DpnToInterfaceBuilder setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInterfaceNameEntry
public DpnToInterfaceBuilder setInterfaceNameEntry(java.util.Map<InterfaceNameEntryKey,InterfaceNameEntry> values)
-
setInterfaceNameEntry
@Deprecated(forRemoval=true) public DpnToInterfaceBuilder setInterfaceNameEntry(java.util.List<InterfaceNameEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceNameEntry(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
-
addAugmentation
public DpnToInterfaceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface> 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
-
addAugmentation
@Deprecated(forRemoval=true) public DpnToInterfaceBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public DpnToInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DpnToInterface>> 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 DpnToInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DpnToInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DpnToInterface,java.lang.IllegalArgumentException>
-
-