Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers
Class RouterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.routers.RouterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Router>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Router,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RouterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Router>
Class that buildsRouterBuilder
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:
RouterBuilder createTarget(int fooXyzzy, int barBaz) { return new RouterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouterBuilder, 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:
RouterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RouterBuilder()
RouterBuilder(AdminAttributes arg)
RouterBuilder(BaseAttributes arg)
RouterBuilder(IdAttributes arg)
RouterBuilder(L3Attributes arg)
RouterBuilder(Router base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RouterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Router> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>>
E$$augmentation(Class<E$$> augmentationType)
Router
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getAdminStateUp()
Boolean
getDistributed()
ExternalGatewayInfo
getExternalGatewayInfo()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getGatewayPortId()
String
getName()
String
getProjectId()
Long
getRevisionNumber()
String
getRouterStatus()
Map<RoutesKey,Routes>
getRoutes()
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()
RouterKey
key()
RouterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> augmentationType)
Remove an augmentation from this builder's product.RouterBuilder
setAdminStateUp(Boolean value)
RouterBuilder
setDistributed(Boolean value)
RouterBuilder
setExternalGatewayInfo(ExternalGatewayInfo value)
RouterBuilder
setGatewayPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
RouterBuilder
setName(String value)
RouterBuilder
setProjectId(String value)
RouterBuilder
setRevisionNumber(Long value)
RouterBuilder
setRouterStatus(String value)
RouterBuilder
setRoutes(Map<RoutesKey,Routes> values)
RouterBuilder
setStatus(String value)
RouterBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
RouterBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
RouterBuilder
withKey(RouterKey key)
-
-
-
Constructor Detail
-
RouterBuilder
public RouterBuilder()
-
RouterBuilder
public RouterBuilder(BaseAttributes arg)
-
RouterBuilder
public RouterBuilder(IdAttributes arg)
-
RouterBuilder
public RouterBuilder(AdminAttributes arg)
-
RouterBuilder
public RouterBuilder(L3Attributes arg)
-
RouterBuilder
public RouterBuilder(Router 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:- L3Attributes
- AdminAttributes
- IdAttributes
- BaseAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public RouterKey key()
-
getAdminStateUp
public Boolean getAdminStateUp()
-
getDistributed
public Boolean getDistributed()
-
getExternalGatewayInfo
public ExternalGatewayInfo getExternalGatewayInfo()
-
getGatewayPortId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getGatewayPortId()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getRouterStatus
public String getRouterStatus()
-
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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public RouterBuilder withKey(RouterKey key)
-
setAdminStateUp
public RouterBuilder setAdminStateUp(Boolean value)
-
setDistributed
public RouterBuilder setDistributed(Boolean value)
-
setExternalGatewayInfo
public RouterBuilder setExternalGatewayInfo(ExternalGatewayInfo value)
-
setGatewayPortId
public RouterBuilder setGatewayPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setName
public RouterBuilder setName(String value)
-
setProjectId
public RouterBuilder setProjectId(String value)
-
setRevisionNumber
public RouterBuilder setRevisionNumber(Long value)
-
setRouterStatus
public RouterBuilder setRouterStatus(String value)
-
setRoutes
public RouterBuilder setRoutes(Map<RoutesKey,Routes> values)
-
setStatus
public RouterBuilder setStatus(String value)
-
setTenantId
public RouterBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public RouterBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public RouterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Router> 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 RouterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> 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 Router build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Router>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Router,IllegalArgumentException>
-
-