Class RouteOriginIpv4Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.route.origin.ipv4._case.RouteOriginIpv4Builder
Class that builds
RouteOriginIpv4
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:
RouteOriginIpv4 createRouteOriginIpv4(int fooXyzzy, int barBaz) {
return new RouteOriginIpv4Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RouteOriginIpv4, 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 specifiedRouteOriginIpv4
.Construct a new builder initialized from specifiedRouteIpv4ExtendedCommunity
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull RouteOriginIpv4
build()
A newRouteOriginIpv4
instance.static @NonNull RouteOriginIpv4
empty()
Get empty instance of RouteOriginIpv4.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
Return current value associated with the property corresponding toRouteIpv4ExtendedCommunity.getGlobalAdministrator()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toRouteIpv4ExtendedCommunity.getLocalAdministrator()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4>> augmentationType) Remove an augmentation from this builder's product.setGlobalAdministrator
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toRouteIpv4ExtendedCommunity.getGlobalAdministrator()
to the specified value.setLocalAdministrator
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toRouteIpv4ExtendedCommunity.getLocalAdministrator()
to the specified value.
-
Constructor Details
-
RouteOriginIpv4Builder
public RouteOriginIpv4Builder()Construct an empty builder. -
RouteOriginIpv4Builder
Construct a new builder initialized from specifiedRouteIpv4ExtendedCommunity
.- Parameters:
arg
- RouteIpv4ExtendedCommunity from which the builder should be initialized
-
RouteOriginIpv4Builder
Construct a builder initialized with state from specifiedRouteOriginIpv4
.- Parameters:
base
- RouteOriginIpv4 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
-
empty
Get empty instance of RouteOriginIpv4.- Returns:
- An empty
RouteOriginIpv4
-
getGlobalAdministrator
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getGlobalAdministrator()Return current value associated with the property corresponding toRouteIpv4ExtendedCommunity.getGlobalAdministrator()
.- Returns:
- current value
-
getLocalAdministrator
public org.opendaylight.yangtools.yang.common.Uint16 getLocalAdministrator()Return current value associated with the property corresponding toRouteIpv4ExtendedCommunity.getLocalAdministrator()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4>> 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
-
setGlobalAdministrator
public RouteOriginIpv4Builder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toRouteIpv4ExtendedCommunity.getGlobalAdministrator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalAdministrator
public RouteOriginIpv4Builder setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toRouteIpv4ExtendedCommunity.getLocalAdministrator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RouteOriginIpv4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4> 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 RouteOriginIpv4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4>> 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 newRouteOriginIpv4
instance.- Returns:
- A new
RouteOriginIpv4
instance.
-