Class RoutersBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.ext.routers.RoutersBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Routers>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Routers,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RoutersBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Routers>
Class that buildsRoutersBuilder
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:
RoutersBuilder createTarget(int fooXyzzy, int barBaz) { return new RoutersBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoutersBuilder, 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:
RoutersBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RoutersBuilder()
RoutersBuilder(Routers base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RoutersBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Routers> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Routers
build()
java.lang.Boolean
getEnableSnat()
java.util.Map<ExternalIpsKey,ExternalIps>
getExternalIps()
java.lang.String
getExtGwMacAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getNetworkId()
java.lang.String
getRouterName()
java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid>
getSubnetIds()
java.lang.Boolean
isEnableSnat()
Deprecated, for removal: This API element is subject to removal in a future version.RoutersKey
key()
RoutersBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> augmentationType)
Remove an augmentation from this builder's product.RoutersBuilder
setEnableSnat(java.lang.Boolean value)
RoutersBuilder
setExternalIps(java.util.List<ExternalIps> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetExternalIps(Map)
instead.RoutersBuilder
setExternalIps(java.util.Map<ExternalIpsKey,ExternalIps> values)
RoutersBuilder
setExtGwMacAddress(java.lang.String value)
RoutersBuilder
setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
RoutersBuilder
setRouterName(java.lang.String value)
RoutersBuilder
setSubnetIds(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
RoutersBuilder
withKey(RoutersKey key)
-
-
-
Constructor Detail
-
RoutersBuilder
public RoutersBuilder()
-
RoutersBuilder
public RoutersBuilder(Routers base)
-
-
Method Detail
-
key
public RoutersKey key()
-
getEnableSnat
public java.lang.Boolean getEnableSnat()
-
isEnableSnat
@Deprecated(forRemoval=true) public final java.lang.Boolean isEnableSnat()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getExtGwMacAddress
public java.lang.String getExtGwMacAddress()
-
getExternalIps
public java.util.Map<ExternalIpsKey,ExternalIps> getExternalIps()
-
getNetworkId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()
-
getRouterName
public java.lang.String getRouterName()
-
getSubnetIds
public java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getSubnetIds()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public RoutersBuilder withKey(RoutersKey key)
-
setEnableSnat
public RoutersBuilder setEnableSnat(java.lang.Boolean value)
-
setExtGwMacAddress
public RoutersBuilder setExtGwMacAddress(java.lang.String value)
-
setExternalIps
public RoutersBuilder setExternalIps(java.util.Map<ExternalIpsKey,ExternalIps> values)
-
setExternalIps
@Deprecated(forRemoval=true) public RoutersBuilder setExternalIps(java.util.List<ExternalIps> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetExternalIps(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
-
setNetworkId
public RoutersBuilder setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setRouterName
public RoutersBuilder setRouterName(java.lang.String value)
-
setSubnetIds
public RoutersBuilder setSubnetIds(java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> values)
-
addAugmentation
public RoutersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Routers> 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 RoutersBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> 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
-
-