Class RouteTargetIpv4Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.route.target.ipv4.grouping.RouteTargetIpv4Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RouteTargetIpv4>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RouteTargetIpv4,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RouteTargetIpv4Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<RouteTargetIpv4>
Class that buildsRouteTargetIpv4
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:
RouteTargetIpv4 createRouteTargetIpv4(int fooXyzzy, int barBaz) { return new RouteTargetIpv4Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouteTargetIpv4, 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:
RouteTargetIpv4
,Builder
-
-
Constructor Summary
Constructors Constructor Description RouteTargetIpv4Builder()
RouteTargetIpv4Builder(RouteTargetIpv4 base)
RouteTargetIpv4Builder(RouteIpv4ExtendedCommunity arg)
RouteTargetIpv4Builder(RouteTarget arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RouteTargetIpv4Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetIpv4> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetIpv4>>
E$$augmentation(Class<E$$> augmentationType)
RouteTargetIpv4
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()
RouteTargetIpv4Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetIpv4>> augmentationType)
Remove an augmentation from this builder's product.RouteTargetIpv4Builder
setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
RouteTargetIpv4Builder
setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
RouteTargetIpv4Builder
public RouteTargetIpv4Builder()
-
RouteTargetIpv4Builder
public RouteTargetIpv4Builder(RouteTarget arg)
-
RouteTargetIpv4Builder
public RouteTargetIpv4Builder(RouteIpv4ExtendedCommunity arg)
-
RouteTargetIpv4Builder
public RouteTargetIpv4Builder(RouteTargetIpv4 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:- RouteTarget
- 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<RouteTargetIpv4>> E$$ augmentation(Class<E$$> augmentationType)
-
setGlobalAdministrator
public RouteTargetIpv4Builder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setLocalAdministrator
public RouteTargetIpv4Builder setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
addAugmentation
public RouteTargetIpv4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetIpv4> 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 RouteTargetIpv4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetIpv4>> 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 RouteTargetIpv4 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RouteTargetIpv4>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RouteTargetIpv4,IllegalArgumentException>
-
-