Class LogicalRoutersBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalRoutersBuilder
Class that builds
LogicalRouters
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:
LogicalRouters createLogicalRouters(int fooXyzzy, int barBaz) {
return new LogicalRoutersBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of LogicalRouters, 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 opportunities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedLogicalRouters
.Construct a new builder initialized from specifiedHwvtepLogicalRouterAttributes
.Construct a new builder initialized from specifiedHwvtepNodeIdentification
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<LogicalRouters> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalRouters>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull LogicalRouters
build()
A newLogicalRouters
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getAclBindings()
.Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
.Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getLogicalRouterUuid()
.Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getStaticRoutes()
.Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getSwitchBindings()
.key()
Return current value associated with the property corresponding toLogicalRouters.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalRouters>> augmentationType) Remove an augmentation from this builder's product.setAclBindings
(Map<AclBindingsKey, AclBindings> values) Set the property corresponding toHwvtepLogicalRouterAttributes.getAclBindings()
to the specified value.setHwvtepNodeDescription
(String value) Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
to the specified value.setHwvtepNodeName
(HwvtepNodeName value) Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
to the specified value.setLogicalRouterUuid
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toHwvtepLogicalRouterAttributes.getLogicalRouterUuid()
to the specified value.setStaticRoutes
(List<StaticRoutes> values) Set the property corresponding toHwvtepLogicalRouterAttributes.getStaticRoutes()
to the specified value.setSwitchBindings
(List<SwitchBindings> values) Set the property corresponding toHwvtepLogicalRouterAttributes.getSwitchBindings()
to the specified value.withKey
(LogicalRoutersKey key) Set the key value corresponding toLogicalRouters.key()
to the specified value.
-
Constructor Details
-
LogicalRoutersBuilder
public LogicalRoutersBuilder()Construct an empty builder. -
LogicalRoutersBuilder
Construct a new builder initialized from specifiedHwvtepLogicalRouterAttributes
.- Parameters:
arg
- HwvtepLogicalRouterAttributes from which the builder should be initialized
-
LogicalRoutersBuilder
Construct a new builder initialized from specifiedHwvtepNodeIdentification
.- Parameters:
arg
- HwvtepNodeIdentification from which the builder should be initialized
-
LogicalRoutersBuilder
Construct a builder initialized with state from specifiedLogicalRouters
.- Parameters:
base
- LogicalRouters from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
Return current value associated with the property corresponding toLogicalRouters.key()
.- Returns:
- current value
-
getAclBindings
Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getAclBindings()
.- Returns:
- current value
-
getHwvtepNodeDescription
Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
.- Returns:
- current value
-
getHwvtepNodeName
Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
.- Returns:
- current value
-
getLogicalRouterUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getLogicalRouterUuid()Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getLogicalRouterUuid()
.- Returns:
- current value
-
getStaticRoutes
Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getStaticRoutes()
.- Returns:
- current value
-
getSwitchBindings
Return current value associated with the property corresponding toHwvtepLogicalRouterAttributes.getSwitchBindings()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalRouters>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
Set the key value corresponding toLogicalRouters.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setAclBindings
Set the property corresponding toHwvtepLogicalRouterAttributes.getAclBindings()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setHwvtepNodeDescription
Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHwvtepNodeName
Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLogicalRouterUuid
public LogicalRoutersBuilder setLogicalRouterUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toHwvtepLogicalRouterAttributes.getLogicalRouterUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStaticRoutes
Set the property corresponding toHwvtepLogicalRouterAttributes.getStaticRoutes()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSwitchBindings
Set the property corresponding toHwvtepLogicalRouterAttributes.getSwitchBindings()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public LogicalRoutersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LogicalRouters> 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 LogicalRoutersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalRouters>> 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
A newLogicalRouters
instance.- Returns:
- A new
LogicalRouters
instance.
-