org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.object

Class EndpointsObjBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.object.EndpointsObjBuilder

All Implemented Interfaces:

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

public class EndpointsObjBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<EndpointsObj>

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

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

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

EndpointsObjBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
EndpointsObjBuilder()
EndpointsObjBuilder(Endpoints arg)
EndpointsObjBuilder(EndpointsObj base)
EndpointsObjBuilder(Object arg)
EndpointsObjBuilder(ObjectHeader arg)

Method Summary

Modifier and Type	Method and Description
EndpointsObjBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>> E$$	augmentation(Class<E$$> augmentationType)
EndpointsObj	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
AddressFamily	getAddressFamily()
Boolean	isIgnore()
Boolean	isProcessingRule()
EndpointsObjBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>> augmentationType)
EndpointsObjBuilder	setAddressFamily(AddressFamily value)
EndpointsObjBuilder	setIgnore(Boolean value)
EndpointsObjBuilder	setProcessingRule(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointsObjBuilder

public EndpointsObjBuilder()

EndpointsObjBuilder

public EndpointsObjBuilder(Object arg)

EndpointsObjBuilder

public EndpointsObjBuilder(ObjectHeader arg)

EndpointsObjBuilder

public EndpointsObjBuilder(Endpoints arg)

EndpointsObjBuilder

public EndpointsObjBuilder(EndpointsObj 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.ObjectHeader
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Endpoints
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getAddressFamily

public AddressFamily getAddressFamily()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EndpointsObj>> E$$ augmentation(Class<E$$> augmentationType)

setAddressFamily

public EndpointsObjBuilder setAddressFamily(AddressFamily value)

setIgnore

public EndpointsObjBuilder setIgnore(Boolean value)

setProcessingRule

public EndpointsObjBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public EndpointsObj build()

Specified by:

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