Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance

Class MappingBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.MappingBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Mapping>, org.opendaylight.yangtools.concepts.CheckedBuilder<Mapping,java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class MappingBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<Mapping>

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

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

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

MappingBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
MappingBuilder()
MappingBuilder(MappingRecordContainer arg)
MappingBuilder(Mapping base)

Method Summary

Modifier and Type	Method	Description
MappingBuilder	addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Mapping> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> E$$	augmentation(java.lang.Class<E$$> augmentationType)
Mapping	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
EidUri	getEidUri()
MappingRecord	getMappingRecord()
MappingOrigin	getOrigin()
java.util.List<SiteId>	getSiteId()
java.util.List<XtrIdMapping>	getXtrIdMapping()
MappingKey	key()
MappingBuilder	removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> augmentationType)
MappingBuilder	setEidUri(EidUri value)
MappingBuilder	setMappingRecord(MappingRecord value)
MappingBuilder	setOrigin(MappingOrigin value)
MappingBuilder	setSiteId(java.util.List<SiteId> values)
MappingBuilder	setXtrIdMapping(java.util.List<XtrIdMapping> values)
MappingBuilder	withKey(MappingKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

MappingBuilder

public MappingBuilder()

MappingBuilder

public MappingBuilder(MappingRecordContainer arg)

MappingBuilder

public MappingBuilder(Mapping 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.lfm.lisp.proto.rev151105.MappingRecordContainer

Parameters:

arg - grouping object

Throws:

java.lang.IllegalArgumentException - if given argument is none of valid types

key

public MappingKey key()

getEidUri

public EidUri getEidUri()

getMappingRecord

public MappingRecord getMappingRecord()

getOrigin

public MappingOrigin getOrigin()

getSiteId

public java.util.List<SiteId> getSiteId()

getXtrIdMapping

public java.util.List<XtrIdMapping> getXtrIdMapping()

augmentation

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

withKey

public MappingBuilder withKey(MappingKey key)

setEidUri

public MappingBuilder setEidUri(EidUri value)

setMappingRecord

public MappingBuilder setMappingRecord(MappingRecord value)

setOrigin

public MappingBuilder setOrigin(MappingOrigin value)

setSiteId

public MappingBuilder setSiteId(java.util.List<SiteId> values)

setXtrIdMapping

public MappingBuilder setXtrIdMapping(java.util.List<XtrIdMapping> values)

addAugmentation

public MappingBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> augmentationType,
                                      org.opendaylight.yangtools.yang.binding.Augmentation<Mapping> augmentationValue)

removeAugmentation

public MappingBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mapping>> augmentationType)

build

public Mapping build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<Mapping>

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Mapping,java.lang.IllegalArgumentException>