Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets
Class SubnetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.subnets.rev150712.subnets.attributes.subnets.SubnetBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Subnet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Subnet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SubnetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Subnet>
Class that buildsSubnetBuilder
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:
SubnetBuilder createTarget(int fooXyzzy, int barBaz) { return new SubnetBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubnetBuilder, 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:
SubnetBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SubnetBuilder()
SubnetBuilder(BaseAttributes arg)
SubnetBuilder(IdAttributes arg)
SubnetBuilder(SubnetAttributes arg)
SubnetBuilder(Subnet base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubnetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Subnet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subnet>>
E$$augmentation(Class<E$$> augmentationType)
Subnet
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<AllocationPoolsKey,AllocationPools>
getAllocationPools()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getCidr()
List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress>
getDnsNameservers()
Boolean
getEnableDhcp()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getGatewayIp()
Map<HostRoutesKey,HostRoutes>
getHostRoutes()
Class<? extends Dhcpv6Base>
getIpv6AddressMode()
Class<? extends Dhcpv6Base>
getIpv6RaMode()
Class<? extends IpVersionBase>
getIpVersion()
String
getName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getNetworkId()
String
getProjectId()
Long
getRevisionNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
SubnetKey
key()
SubnetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subnet>> augmentationType)
Remove an augmentation from this builder's product.SubnetBuilder
setAllocationPools(Map<AllocationPoolsKey,AllocationPools> values)
SubnetBuilder
setCidr(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
SubnetBuilder
setDnsNameservers(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)
SubnetBuilder
setEnableDhcp(Boolean value)
SubnetBuilder
setGatewayIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
SubnetBuilder
setHostRoutes(Map<HostRoutesKey,HostRoutes> values)
SubnetBuilder
setIpv6AddressMode(Class<? extends Dhcpv6Base> value)
SubnetBuilder
setIpv6RaMode(Class<? extends Dhcpv6Base> value)
SubnetBuilder
setIpVersion(Class<? extends IpVersionBase> value)
SubnetBuilder
setName(String value)
SubnetBuilder
setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SubnetBuilder
setProjectId(String value)
SubnetBuilder
setRevisionNumber(Long value)
SubnetBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SubnetBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SubnetBuilder
withKey(SubnetKey key)
-
-
-
Constructor Detail
-
SubnetBuilder
public SubnetBuilder()
-
SubnetBuilder
public SubnetBuilder(BaseAttributes arg)
-
SubnetBuilder
public SubnetBuilder(IdAttributes arg)
-
SubnetBuilder
public SubnetBuilder(SubnetAttributes arg)
-
SubnetBuilder
public SubnetBuilder(Subnet 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:- SubnetAttributes
- IdAttributes
- BaseAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public SubnetKey key()
-
getAllocationPools
public Map<AllocationPoolsKey,AllocationPools> getAllocationPools()
-
getCidr
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getCidr()
-
getDnsNameservers
public List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getDnsNameservers()
-
getEnableDhcp
public Boolean getEnableDhcp()
-
getGatewayIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getGatewayIp()
-
getHostRoutes
public Map<HostRoutesKey,HostRoutes> getHostRoutes()
-
getIpVersion
public Class<? extends IpVersionBase> getIpVersion()
-
getIpv6AddressMode
public Class<? extends Dhcpv6Base> getIpv6AddressMode()
-
getIpv6RaMode
public Class<? extends Dhcpv6Base> getIpv6RaMode()
-
getName
public String getName()
-
getNetworkId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getNetworkId()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getTenantId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
-
getUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subnet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SubnetBuilder withKey(SubnetKey key)
-
setAllocationPools
public SubnetBuilder setAllocationPools(Map<AllocationPoolsKey,AllocationPools> values)
-
setCidr
public SubnetBuilder setCidr(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setDnsNameservers
public SubnetBuilder setDnsNameservers(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)
-
setEnableDhcp
public SubnetBuilder setEnableDhcp(Boolean value)
-
setGatewayIp
public SubnetBuilder setGatewayIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setHostRoutes
public SubnetBuilder setHostRoutes(Map<HostRoutesKey,HostRoutes> values)
-
setIpVersion
public SubnetBuilder setIpVersion(Class<? extends IpVersionBase> value)
-
setIpv6AddressMode
public SubnetBuilder setIpv6AddressMode(Class<? extends Dhcpv6Base> value)
-
setIpv6RaMode
public SubnetBuilder setIpv6RaMode(Class<? extends Dhcpv6Base> value)
-
setName
public SubnetBuilder setName(String value)
-
setNetworkId
public SubnetBuilder setNetworkId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setProjectId
public SubnetBuilder setProjectId(String value)
-
setRevisionNumber
public SubnetBuilder setRevisionNumber(Long value)
-
setTenantId
public SubnetBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public SubnetBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public SubnetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Subnet> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public SubnetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subnet>> 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 Subnet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Subnet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Subnet,IllegalArgumentException>
-
-