Class NetworkBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.networks.rev150712.networks.attributes.networks.NetworkBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Network>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Network,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NetworkBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Network>
Class that buildsNetworkBuilder
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:
NetworkBuilder createTarget(int fooXyzzy, int barBaz) { return new NetworkBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NetworkBuilder, 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:
NetworkBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NetworkBuilder()
NetworkBuilder(AdminAttributes arg)
NetworkBuilder(BaseAttributes arg)
NetworkBuilder(IdAttributes arg)
NetworkBuilder(Network base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NetworkBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Network> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.NetworkBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Network> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>>
E$$augmentation(Class<E$$> augmentationType)
Network
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getName()
String
getProjectId()
Long
getRevisionNumber()
String
getStatus()
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()
Boolean
isAdminStateUp()
Boolean
isShared()
Boolean
isVlanTransparent()
NetworkKey
key()
NetworkBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> augmentationType)
Remove an augmentation from this builder's product.NetworkBuilder
setAdminStateUp(Boolean value)
NetworkBuilder
setName(String value)
NetworkBuilder
setProjectId(String value)
NetworkBuilder
setRevisionNumber(Long value)
NetworkBuilder
setShared(Boolean value)
NetworkBuilder
setStatus(String value)
NetworkBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
NetworkBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
NetworkBuilder
setVlanTransparent(Boolean value)
NetworkBuilder
withKey(NetworkKey key)
-
-
-
Constructor Detail
-
NetworkBuilder
public NetworkBuilder()
-
NetworkBuilder
public NetworkBuilder(BaseAttributes arg)
-
NetworkBuilder
public NetworkBuilder(IdAttributes arg)
-
NetworkBuilder
public NetworkBuilder(AdminAttributes arg)
-
NetworkBuilder
public NetworkBuilder(Network 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.neutron.attrs.rev150712.AdminAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public NetworkKey key()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getStatus
public String getStatus()
-
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()
-
isAdminStateUp
public Boolean isAdminStateUp()
-
isShared
public Boolean isShared()
-
isVlanTransparent
public Boolean isVlanTransparent()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public NetworkBuilder withKey(NetworkKey key)
-
setName
public NetworkBuilder setName(String value)
-
setProjectId
public NetworkBuilder setProjectId(String value)
-
setRevisionNumber
public NetworkBuilder setRevisionNumber(Long value)
-
setStatus
public NetworkBuilder setStatus(String value)
-
setTenantId
public NetworkBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public NetworkBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setAdminStateUp
public NetworkBuilder setAdminStateUp(Boolean value)
-
setShared
public NetworkBuilder setShared(Boolean value)
-
setVlanTransparent
public NetworkBuilder setVlanTransparent(Boolean value)
-
addAugmentation
public NetworkBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Network> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public NetworkBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Network> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public NetworkBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Network>> 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 Network build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Network>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Network,IllegalArgumentException>
-
-