Class VxlanBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.VxlanBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Vxlan>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Vxlan,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VxlanBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Vxlan>
Class that buildsVxlanBuilder
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:
VxlanBuilder createTarget(int fooXyzzy, int barBaz) { return new VxlanBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VxlanBuilder, 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:
VxlanBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VxlanBuilder()
VxlanBuilder(Vxlan base)
VxlanBuilder(VxlanBaseAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VxlanBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Vxlan
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.Class<? extends DecapNode>
getDecapNext()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getDst()
org.opendaylight.yangtools.yang.common.Uint32
getEncapVrfId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getSrc()
VxlanVni
getVni()
VxlanBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan>> augmentationType)
VxlanBuilder
setDecapNext(java.lang.Class<? extends DecapNode> value)
VxlanBuilder
setDst(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
VxlanBuilder
setEncapVrfId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setEncapVrfId(Uint32)} instead.VxlanBuilder
setEncapVrfId(org.opendaylight.yangtools.yang.common.Uint32 value)
VxlanBuilder
setSrc(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
VxlanBuilder
setVni(VxlanVni value)
-
-
-
Constructor Detail
-
VxlanBuilder
public VxlanBuilder()
-
VxlanBuilder
public VxlanBuilder(VxlanBaseAttributes arg)
-
VxlanBuilder
public VxlanBuilder(Vxlan 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.params.xml.ns.yang.v3po.rev170607.VxlanBaseAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getDecapNext
public java.lang.Class<? extends DecapNode> getDecapNext()
-
getDst
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getDst()
-
getEncapVrfId
public org.opendaylight.yangtools.yang.common.Uint32 getEncapVrfId()
-
getSrc
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getSrc()
-
getVni
public VxlanVni getVni()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setDecapNext
public VxlanBuilder setDecapNext(java.lang.Class<? extends DecapNode> value)
-
setDst
public VxlanBuilder setDst(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setEncapVrfId
public VxlanBuilder setEncapVrfId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setEncapVrfId
@Deprecated(forRemoval=true) public VxlanBuilder setEncapVrfId(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setEncapVrfId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSrc
public VxlanBuilder setSrc(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setVni
public VxlanBuilder setVni(VxlanVni value)
-
addAugmentation
public VxlanBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan> augmentationValue)
-
removeAugmentation
public VxlanBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vxlan>> augmentationType)
-
-