Class VrfEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.vrfentries.VrfEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VrfEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VrfEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VrfEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VrfEntry>
Class that buildsVrfEntryBuilder
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:
VrfEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new VrfEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VrfEntryBuilder, 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:
VrfEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VrfEntryBuilder()
VrfEntryBuilder(VrfEntry base)
VrfEntryBuilder(VrfEntryBase arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VrfEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VrfEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VrfEntry
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
getL3vni()
java.lang.String
getMac()
java.lang.String
getOrigin()
java.lang.String
getParentVpnRd()
java.util.Map<RoutePathsKey,RoutePaths>
getRoutePaths()
VrfEntryKey
key()
VrfEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfEntry>> augmentationType)
Remove an augmentation from this builder's product.VrfEntryBuilder
setDestPrefix(java.lang.String value)
VrfEntryBuilder
setEncapType(VrfEntryBase.EncapType value)
VrfEntryBuilder
setGatewayMacAddress(java.lang.String value)
VrfEntryBuilder
setL3vni(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vni(Uint32)
instead.VrfEntryBuilder
setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
VrfEntryBuilder
setMac(java.lang.String value)
VrfEntryBuilder
setOrigin(java.lang.String value)
VrfEntryBuilder
setParentVpnRd(java.lang.String value)
VrfEntryBuilder
setRoutePaths(java.util.List<RoutePaths> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetRoutePaths(Map)
instead.VrfEntryBuilder
setRoutePaths(java.util.Map<RoutePathsKey,RoutePaths> values)
VrfEntryBuilder
withKey(VrfEntryKey key)
-
-
-
Constructor Detail
-
VrfEntryBuilder
public VrfEntryBuilder()
-
VrfEntryBuilder
public VrfEntryBuilder(VrfEntryBase arg)
-
VrfEntryBuilder
public VrfEntryBuilder(VrfEntry 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 VrfEntryKey key()
-
getDestPrefix
public java.lang.String getDestPrefix()
-
getEncapType
public VrfEntryBase.EncapType getEncapType()
-
getGatewayMacAddress
public java.lang.String getGatewayMacAddress()
-
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<VrfEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VrfEntryBuilder withKey(VrfEntryKey key)
-
setDestPrefix
public VrfEntryBuilder setDestPrefix(java.lang.String value)
-
setEncapType
public VrfEntryBuilder setEncapType(VrfEntryBase.EncapType value)
-
setGatewayMacAddress
public VrfEntryBuilder setGatewayMacAddress(java.lang.String value)
-
setL3vni
public VrfEntryBuilder setL3vni(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setL3vni
@Deprecated(forRemoval=true) public VrfEntryBuilder 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 VrfEntryBuilder setMac(java.lang.String value)
-
setOrigin
public VrfEntryBuilder setOrigin(java.lang.String value)
-
setParentVpnRd
public VrfEntryBuilder setParentVpnRd(java.lang.String value)
-
setRoutePaths
public VrfEntryBuilder setRoutePaths(java.util.Map<RoutePathsKey,RoutePaths> values)
-
setRoutePaths
@Deprecated(forRemoval=true) public VrfEntryBuilder 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 VrfEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VrfEntry> 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 VrfEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfEntry>> 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
-
-