Class Ipv4Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv4._case.Ipv4Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv4Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4>
Class that buildsIpv4
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:
Ipv4 createIpv4(int fooXyzzy, int barBaz) { return new Ipv4Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4, 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:
Ipv4
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4Builder()
Ipv4Builder(Ipv4 base)
Ipv4Builder(EndpointsIpv4Source arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv4Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>>
E$$augmentation(Class<E$$> augmentationType)
Ipv4
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
getDestinationIpv4Address()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getSourceIpv4Address()
Ipv4Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType)
Remove an augmentation from this builder's product.Ipv4Builder
setDestinationIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
Ipv4Builder
setSourceIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
-
-
Constructor Detail
-
Ipv4Builder
public Ipv4Builder()
-
Ipv4Builder
public Ipv4Builder(EndpointsIpv4Source arg)
-
Ipv4Builder
public Ipv4Builder(Ipv4 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:- EndpointsIpv4Source
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getDestinationIpv4Address
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getDestinationIpv4Address()
-
getSourceIpv4Address
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getSourceIpv4Address()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> E$$ augmentation(Class<E$$> augmentationType)
-
setDestinationIpv4Address
public Ipv4Builder setDestinationIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setSourceIpv4Address
public Ipv4Builder setSourceIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
addAugmentation
public Ipv4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> 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 Ipv4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> 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 Ipv4 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv4>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4,IllegalArgumentException>
-
-