org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv4._case

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>

public class Ipv4Builder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Ipv4>

Class that builds Ipv4Builder 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:

   
     Ipv4Builder createTarget(int fooXyzzy, int barBaz) {
         return new Ipv4BuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of Ipv4Builder, 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:

Ipv4Builder, Builder

Constructor Summary

Constructors

Constructor and Description
Ipv4Builder()
Ipv4Builder(EndpointsIpv4Source arg)
Ipv4Builder(Ipv4 base)

Method Summary

Modifier and Type	Method and Description
Ipv4Builder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> augmentationValue)
<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)
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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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:

• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.EndpointsIpv4Source

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

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(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType,
                                   org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> augmentationValue)

removeAugmentation

public Ipv4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType)

build

public Ipv4 build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4,IllegalArgumentException>