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

Class P2mpIpv4Builder

java.lang.Object

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

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<P2mpIpv4>, org.opendaylight.yangtools.concepts.CheckedBuilder<P2mpIpv4,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class P2mpIpv4Builder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<P2mpIpv4>

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

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

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

P2mpIpv4Builder, Builder

Constructor Summary

Constructors

Constructor and Description
P2mpIpv4Builder()
P2mpIpv4Builder(EndpointsIpv4Source arg)
P2mpIpv4Builder(Ipv4Destinations arg)
P2mpIpv4Builder(P2mpIpv4 base)
P2mpIpv4Builder(P2mpLeavesLeaf arg)

Method Summary

Modifier and Type	Method and Description
P2mpIpv4Builder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4>> E$$	augmentation(Class<E$$> augmentationType)
P2mpIpv4	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone>	getDestinationIpv4Address()
P2mpLeaves	getP2mpLeaves()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone	getSourceIpv4Address()
P2mpIpv4Builder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4>> augmentationType)
P2mpIpv4Builder	setDestinationIpv4Address(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> values)
P2mpIpv4Builder	setP2mpLeaves(P2mpLeaves value)
P2mpIpv4Builder	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

P2mpIpv4Builder

public P2mpIpv4Builder()

P2mpIpv4Builder

public P2mpIpv4Builder(P2mpLeavesLeaf arg)

P2mpIpv4Builder

public P2mpIpv4Builder(EndpointsIpv4Source arg)

P2mpIpv4Builder

public P2mpIpv4Builder(Ipv4Destinations arg)

P2mpIpv4Builder

public P2mpIpv4Builder(P2mpIpv4 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.Ipv4Destinations
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.P2mpLeavesLeaf
• 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 List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> getDestinationIpv4Address()

getP2mpLeaves

public P2mpLeaves getP2mpLeaves()

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<P2mpIpv4>> E$$ augmentation(Class<E$$> augmentationType)

setDestinationIpv4Address

public P2mpIpv4Builder setDestinationIpv4Address(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> values)

setP2mpLeaves

public P2mpIpv4Builder setP2mpLeaves(P2mpLeaves value)

setSourceIpv4Address

public P2mpIpv4Builder setSourceIpv4Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)

addAugmentation

public P2mpIpv4Builder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4>> augmentationType,
                                       org.opendaylight.yangtools.yang.binding.Augmentation<P2mpIpv4> augmentationValue)

removeAugmentation

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

build

public P2mpIpv4 build()

Specified by:

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