Class MacVrfEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.macvrfentries.MacVrfEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MacVrfEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MacVrfEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MacVrfEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MacVrfEntry>
Class that buildsMacVrfEntryBuilder
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:
MacVrfEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new MacVrfEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MacVrfEntryBuilder, 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:
MacVrfEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MacVrfEntryBuilder()
MacVrfEntryBuilder(MacVrfEntry base)
MacVrfEntryBuilder(VrfEntryBase arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MacVrfEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MacVrfEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MacVrfEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
MacVrfEntry
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.String
getDestPrefix()
VrfEntryBase.EncapType
getEncapType()
java.lang.String
getGatewayMacAddress()
org.opendaylight.yangtools.yang.common.Uint32
getL2vni()
org.opendaylight.yangtools.yang.common.Uint32
getL3vni()
java.lang.String
getMac()
java.lang.String
getOrigin()
java.lang.String
getParentVpnRd()
java.util.Map<RoutePathsKey,RoutePaths>
getRoutePaths()
MacVrfEntryKey
key()
MacVrfEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MacVrfEntry>> augmentationType)
Remove an augmentation from this builder's product.MacVrfEntryBuilder
setDestPrefix(java.lang.String value)
MacVrfEntryBuilder
setEncapType(VrfEntryBase.EncapType value)
MacVrfEntryBuilder
setGatewayMacAddress(java.lang.String value)
MacVrfEntryBuilder
setL2vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2vni(Uint32)
instead.MacVrfEntryBuilder
setL2vni(org.opendaylight.yangtools.yang.common.Uint32 value)
MacVrfEntryBuilder
setL3vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vni(Uint32)
instead.MacVrfEntryBuilder
setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
MacVrfEntryBuilder
setMac(java.lang.String value)
MacVrfEntryBuilder
setOrigin(java.lang.String value)
MacVrfEntryBuilder
setParentVpnRd(java.lang.String value)
MacVrfEntryBuilder
setRoutePaths(java.util.List<RoutePaths> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRoutePaths(Map)
instead.MacVrfEntryBuilder
setRoutePaths(java.util.Map<RoutePathsKey,RoutePaths> values)
MacVrfEntryBuilder
withKey(MacVrfEntryKey key)
-
-
-
Constructor Detail
-
MacVrfEntryBuilder
public MacVrfEntryBuilder()
-
MacVrfEntryBuilder
public MacVrfEntryBuilder(VrfEntryBase arg)
-
MacVrfEntryBuilder
public MacVrfEntryBuilder(MacVrfEntry 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.netvirt.fibmanager.rev150330.VrfEntryBase
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public MacVrfEntryKey key()
-
getDestPrefix
public java.lang.String getDestPrefix()
-
getEncapType
public VrfEntryBase.EncapType getEncapType()
-
getGatewayMacAddress
public java.lang.String getGatewayMacAddress()
-
getL2vni
public org.opendaylight.yangtools.yang.common.Uint32 getL2vni()
-
getL3vni
public org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
-
getMac
public java.lang.String getMac()
-
getOrigin
public java.lang.String getOrigin()
-
getParentVpnRd
public java.lang.String getParentVpnRd()
-
getRoutePaths
public java.util.Map<RoutePathsKey,RoutePaths> getRoutePaths()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MacVrfEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public MacVrfEntryBuilder withKey(MacVrfEntryKey key)
-
setDestPrefix
public MacVrfEntryBuilder setDestPrefix(java.lang.String value)
-
setEncapType
public MacVrfEntryBuilder setEncapType(VrfEntryBase.EncapType value)
-
setGatewayMacAddress
public MacVrfEntryBuilder setGatewayMacAddress(java.lang.String value)
-
setL2vni
public MacVrfEntryBuilder setL2vni(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setL2vni
@Deprecated(forRemoval=true) public MacVrfEntryBuilder setL2vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2vni(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setL3vni
public MacVrfEntryBuilder setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setL3vni
@Deprecated(forRemoval=true) public MacVrfEntryBuilder setL3vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vni(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMac
public MacVrfEntryBuilder setMac(java.lang.String value)
-
setOrigin
public MacVrfEntryBuilder setOrigin(java.lang.String value)
-
setParentVpnRd
public MacVrfEntryBuilder setParentVpnRd(java.lang.String value)
-
setRoutePaths
public MacVrfEntryBuilder setRoutePaths(java.util.Map<RoutePathsKey,RoutePaths> values)
-
setRoutePaths
@Deprecated(forRemoval=true) public MacVrfEntryBuilder setRoutePaths(java.util.List<RoutePaths> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRoutePaths(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 MacVrfEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MacVrfEntry> 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 MacVrfEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MacVrfEntry>> 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 MacVrfEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MacVrfEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MacVrfEntry,java.lang.IllegalArgumentException>
-
-