Class MapRegisterCacheValueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.value.grouping.MapRegisterCacheValueBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MapRegisterCacheValue>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MapRegisterCacheValue,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MapRegisterCacheValueBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MapRegisterCacheValue>
Class that buildsMapRegisterCacheValue
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:
MapRegisterCacheValue createMapRegisterCacheValue(int fooXyzzy, int barBaz) { return new MapRegisterCacheValueBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MapRegisterCacheValue, 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:
MapRegisterCacheValue
,Builder
-
-
Constructor Summary
Constructors Constructor Description MapRegisterCacheValueBuilder()
MapRegisterCacheValueBuilder(MapRegisterCacheValue base)
MapRegisterCacheValueBuilder(MappingAuthkeyContainer arg)
MapRegisterCacheValueBuilder(MapRegisterCacheMetadataContainer arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MapRegisterCacheValueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheValue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheValue>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
MapRegisterCacheValue
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MappingAuthkey
getMappingAuthkey()
MapRegisterCacheMetadata
getMapRegisterCacheMetadata()
byte[]
getPacketData()
MapRegisterCacheValueBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheValue>> augmentationType)
Remove an augmentation from this builder's product.MapRegisterCacheValueBuilder
setMappingAuthkey(MappingAuthkey value)
MapRegisterCacheValueBuilder
setMapRegisterCacheMetadata(MapRegisterCacheMetadata value)
MapRegisterCacheValueBuilder
setPacketData(byte[] value)
-
-
-
Constructor Detail
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder()
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder(MapRegisterCacheMetadataContainer arg)
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder(MappingAuthkeyContainer arg)
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder(MapRegisterCacheValue 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:- MapRegisterCacheMetadataContainer
- MappingAuthkeyContainer
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMapRegisterCacheMetadata
public MapRegisterCacheMetadata getMapRegisterCacheMetadata()
-
getMappingAuthkey
public MappingAuthkey getMappingAuthkey()
-
getPacketData
public byte[] getPacketData()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheValue>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setMapRegisterCacheMetadata
public MapRegisterCacheValueBuilder setMapRegisterCacheMetadata(MapRegisterCacheMetadata value)
-
setMappingAuthkey
public MapRegisterCacheValueBuilder setMappingAuthkey(MappingAuthkey value)
-
setPacketData
public MapRegisterCacheValueBuilder setPacketData(byte[] value)
-
addAugmentation
public MapRegisterCacheValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheValue> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MapRegisterCacheValueBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheValue>> 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 MapRegisterCacheValue build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MapRegisterCacheValue>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MapRegisterCacheValue,java.lang.IllegalArgumentException>
-
-