Class InterfaceParentEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406._interface.child.info.InterfaceParentEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InterfaceParentEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceParentEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InterfaceParentEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<InterfaceParentEntry>
Class that buildsInterfaceParentEntryBuilder
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:
InterfaceParentEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new InterfaceParentEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceParentEntryBuilder, 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:
InterfaceParentEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InterfaceParentEntryBuilder()
InterfaceParentEntryBuilder(InterfaceParentEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InterfaceParentEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceParentEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceParentEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
InterfaceParentEntry
build()
java.util.Map<InterfaceChildEntryKey,InterfaceChildEntry>
getInterfaceChildEntry()
java.lang.String
getParentInterface()
InterfaceParentEntryKey
key()
InterfaceParentEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceParentEntry>> augmentationType)
Remove an augmentation from this builder's product.InterfaceParentEntryBuilder
setInterfaceChildEntry(java.util.List<InterfaceChildEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceChildEntry(Map)
instead.InterfaceParentEntryBuilder
setInterfaceChildEntry(java.util.Map<InterfaceChildEntryKey,InterfaceChildEntry> values)
InterfaceParentEntryBuilder
setParentInterface(java.lang.String value)
InterfaceParentEntryBuilder
withKey(InterfaceParentEntryKey key)
-
-
-
Constructor Detail
-
InterfaceParentEntryBuilder
public InterfaceParentEntryBuilder()
-
InterfaceParentEntryBuilder
public InterfaceParentEntryBuilder(InterfaceParentEntry base)
-
-
Method Detail
-
key
public InterfaceParentEntryKey key()
-
getInterfaceChildEntry
public java.util.Map<InterfaceChildEntryKey,InterfaceChildEntry> getInterfaceChildEntry()
-
getParentInterface
public java.lang.String getParentInterface()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceParentEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public InterfaceParentEntryBuilder withKey(InterfaceParentEntryKey key)
-
setInterfaceChildEntry
public InterfaceParentEntryBuilder setInterfaceChildEntry(java.util.Map<InterfaceChildEntryKey,InterfaceChildEntry> values)
-
setInterfaceChildEntry
@Deprecated(forRemoval=true) public InterfaceParentEntryBuilder setInterfaceChildEntry(java.util.List<InterfaceChildEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceChildEntry(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
-
setParentInterface
public InterfaceParentEntryBuilder setParentInterface(java.lang.String value)
-
addAugmentation
public InterfaceParentEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceParentEntry> 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 InterfaceParentEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceParentEntry>> 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 InterfaceParentEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InterfaceParentEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InterfaceParentEntry,java.lang.IllegalArgumentException>
-
-