Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list
Class AdjacencyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list.AdjacencyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Adjacency>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Adjacency,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AdjacencyBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Adjacency>
Class that buildsAdjacencyBuilder
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:
AdjacencyBuilder createTarget(int fooXyzzy, int barBaz) { return new AdjacencyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AdjacencyBuilder, 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:
AdjacencyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AdjacencyBuilder()
AdjacencyBuilder(Adjacency base)
AdjacencyBuilder(AdjacencyOpData arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AdjacencyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Adjacency
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Adjacency.AdjacencyType
getAdjacencyType()
java.lang.String
getIpAddress()
org.opendaylight.yangtools.yang.common.Uint32
getLabel()
java.lang.String
getMacAddress()
java.lang.Boolean
getMarkedForDeletion()
java.util.List<java.lang.String>
getNextHopIpList()
java.lang.Boolean
getPhysNetworkFunc()
java.lang.String
getSubnetGatewayIp()
java.lang.String
getSubnetGatewayMacAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getSubnetId()
java.lang.String
getVrfId()
java.lang.Boolean
isMarkedForDeletion()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isPhysNetworkFunc()
Deprecated, for removal: This API element is subject to removal in a future version.AdjacencyKey
key()
AdjacencyBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>> augmentationType)
Remove an augmentation from this builder's product.AdjacencyBuilder
setAdjacencyType(Adjacency.AdjacencyType value)
AdjacencyBuilder
setIpAddress(java.lang.String value)
AdjacencyBuilder
setLabel(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLabel(Uint32)
instead.AdjacencyBuilder
setLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
AdjacencyBuilder
setMacAddress(java.lang.String value)
AdjacencyBuilder
setMarkedForDeletion(java.lang.Boolean value)
AdjacencyBuilder
setNextHopIpList(java.util.List<java.lang.String> values)
AdjacencyBuilder
setPhysNetworkFunc(java.lang.Boolean value)
AdjacencyBuilder
setSubnetGatewayIp(java.lang.String value)
AdjacencyBuilder
setSubnetGatewayMacAddress(java.lang.String value)
AdjacencyBuilder
setSubnetId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
AdjacencyBuilder
setVrfId(java.lang.String value)
AdjacencyBuilder
withKey(AdjacencyKey key)
-
-
-
Constructor Detail
-
AdjacencyBuilder
public AdjacencyBuilder()
-
AdjacencyBuilder
public AdjacencyBuilder(AdjacencyOpData arg)
-
AdjacencyBuilder
public AdjacencyBuilder(Adjacency 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.neutronvpn.l3vpn.rev200204.AdjacencyOpData
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public AdjacencyKey key()
-
getAdjacencyType
public Adjacency.AdjacencyType getAdjacencyType()
-
getIpAddress
public java.lang.String getIpAddress()
-
getLabel
public org.opendaylight.yangtools.yang.common.Uint32 getLabel()
-
getMacAddress
public java.lang.String getMacAddress()
-
getMarkedForDeletion
public java.lang.Boolean getMarkedForDeletion()
-
isMarkedForDeletion
@Deprecated(forRemoval=true) public final java.lang.Boolean isMarkedForDeletion()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getNextHopIpList
public java.util.List<java.lang.String> getNextHopIpList()
-
getPhysNetworkFunc
public java.lang.Boolean getPhysNetworkFunc()
-
isPhysNetworkFunc
@Deprecated(forRemoval=true) public final java.lang.Boolean isPhysNetworkFunc()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSubnetGatewayIp
public java.lang.String getSubnetGatewayIp()
-
getSubnetGatewayMacAddress
public java.lang.String getSubnetGatewayMacAddress()
-
getSubnetId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSubnetId()
-
getVrfId
public java.lang.String getVrfId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public AdjacencyBuilder withKey(AdjacencyKey key)
-
setAdjacencyType
public AdjacencyBuilder setAdjacencyType(Adjacency.AdjacencyType value)
-
setIpAddress
public AdjacencyBuilder setIpAddress(java.lang.String value)
-
setLabel
public AdjacencyBuilder setLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setLabel
@Deprecated(forRemoval=true) public AdjacencyBuilder setLabel(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLabel(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMacAddress
public AdjacencyBuilder setMacAddress(java.lang.String value)
-
setMarkedForDeletion
public AdjacencyBuilder setMarkedForDeletion(java.lang.Boolean value)
-
setNextHopIpList
public AdjacencyBuilder setNextHopIpList(java.util.List<java.lang.String> values)
-
setPhysNetworkFunc
public AdjacencyBuilder setPhysNetworkFunc(java.lang.Boolean value)
-
setSubnetGatewayIp
public AdjacencyBuilder setSubnetGatewayIp(java.lang.String value)
-
setSubnetGatewayMacAddress
public AdjacencyBuilder setSubnetGatewayMacAddress(java.lang.String value)
-
setSubnetId
public AdjacencyBuilder setSubnetId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setVrfId
public AdjacencyBuilder setVrfId(java.lang.String value)
-
addAugmentation
public AdjacencyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency> 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 AdjacencyBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Adjacency>> 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
-
-