Class ElanInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.elan.interfaces.ElanInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ElanInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ElanInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ElanInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<ElanInterface>
Class that buildsElanInterfaceBuilder
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:
ElanInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new ElanInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ElanInterfaceBuilder, 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:
ElanInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ElanInterfaceBuilder()
ElanInterfaceBuilder(ElanInterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ElanInterfaceBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ElanInterface> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ElanInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
ElanInterface
build()
java.lang.String
getDescription()
java.lang.String
getElanInstanceName()
java.lang.String
getName()
java.util.Map<StaticMacEntriesKey,StaticMacEntries>
getStaticMacEntries()
ElanInterfaceKey
key()
ElanInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ElanInterface>> augmentationType)
Remove an augmentation from this builder's product.ElanInterfaceBuilder
setDescription(java.lang.String value)
ElanInterfaceBuilder
setElanInstanceName(java.lang.String value)
ElanInterfaceBuilder
setName(java.lang.String value)
ElanInterfaceBuilder
setStaticMacEntries(java.util.List<StaticMacEntries> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStaticMacEntries(Map)
instead.ElanInterfaceBuilder
setStaticMacEntries(java.util.Map<StaticMacEntriesKey,StaticMacEntries> values)
ElanInterfaceBuilder
withKey(ElanInterfaceKey key)
-
-
-
Constructor Detail
-
ElanInterfaceBuilder
public ElanInterfaceBuilder()
-
ElanInterfaceBuilder
public ElanInterfaceBuilder(ElanInterface base)
-
-
Method Detail
-
key
public ElanInterfaceKey key()
-
getDescription
public java.lang.String getDescription()
-
getElanInstanceName
public java.lang.String getElanInstanceName()
-
getName
public java.lang.String getName()
-
getStaticMacEntries
public java.util.Map<StaticMacEntriesKey,StaticMacEntries> getStaticMacEntries()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ElanInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public ElanInterfaceBuilder withKey(ElanInterfaceKey key)
-
setDescription
public ElanInterfaceBuilder setDescription(java.lang.String value)
-
setElanInstanceName
public ElanInterfaceBuilder setElanInstanceName(java.lang.String value)
-
setName
public ElanInterfaceBuilder setName(java.lang.String value)
-
setStaticMacEntries
public ElanInterfaceBuilder setStaticMacEntries(java.util.Map<StaticMacEntriesKey,StaticMacEntries> values)
-
setStaticMacEntries
@Deprecated(forRemoval=true) public ElanInterfaceBuilder setStaticMacEntries(java.util.List<StaticMacEntries> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStaticMacEntries(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 ElanInterfaceBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ElanInterface> 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 ElanInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ElanInterface>> 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 ElanInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ElanInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ElanInterface,java.lang.IllegalArgumentException>
-
-