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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RouteOriginIpv4>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RouteOriginIpv4,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RouteOriginIpv4Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<RouteOriginIpv4>
Class that buildsRouteOriginIpv4Builder
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:
RouteOriginIpv4Builder createTarget(int fooXyzzy, int barBaz) { return new RouteOriginIpv4BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouteOriginIpv4Builder, 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:
RouteOriginIpv4Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RouteOriginIpv4Builder()
RouteOriginIpv4Builder(RouteOriginIpv4 base)
RouteOriginIpv4Builder(RouteIpv4ExtendedCommunity arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RouteOriginIpv4Builder
addAugmentation(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)
RouteOriginIpv4
build()
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
getGlobalAdministrator()
org.opendaylight.yangtools.yang.common.Uint16
getLocalAdministrator()
RouteOriginIpv4Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4>> augmentationType)
Remove an augmentation from this builder's product.RouteOriginIpv4Builder
setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
RouteOriginIpv4Builder
setLocalAdministrator(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLocalAdministrator(Uint16)
instead.RouteOriginIpv4Builder
setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
RouteOriginIpv4Builder
public RouteOriginIpv4Builder()
-
RouteOriginIpv4Builder
public RouteOriginIpv4Builder(RouteIpv4ExtendedCommunity arg)
-
RouteOriginIpv4Builder
public RouteOriginIpv4Builder(RouteOriginIpv4 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.params.xml.ns.yang.bgp.types.rev200120.RouteIpv4ExtendedCommunity
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getGlobalAdministrator
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getGlobalAdministrator()
-
getLocalAdministrator
public org.opendaylight.yangtools.yang.common.Uint16 getLocalAdministrator()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteOriginIpv4>> E$$ augmentation(Class<E$$> augmentationType)
-
setGlobalAdministrator
public RouteOriginIpv4Builder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setLocalAdministrator
public RouteOriginIpv4Builder setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setLocalAdministrator
@Deprecated(forRemoval=true) public RouteOriginIpv4Builder setLocalAdministrator(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLocalAdministrator(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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
public RouteOriginIpv4 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RouteOriginIpv4>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RouteOriginIpv4,IllegalArgumentException>
-
-