Class MapRegisterCacheValueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.value.grouping.MapRegisterCacheValueBuilder
-
@Generated("mdsal-binding-generator") public class MapRegisterCacheValueBuilder extends java.lang.Object
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
- 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
-
-
Constructor Summary
Constructors Constructor Description MapRegisterCacheValueBuilder()
Construct an empty builder.MapRegisterCacheValueBuilder(MapRegisterCacheValue base)
Construct a builder initialized with state from specifiedMapRegisterCacheValue
.MapRegisterCacheValueBuilder(MappingAuthkeyContainer arg)
Construct a new builder initialized from specifiedMappingAuthkeyContainer
.MapRegisterCacheValueBuilder(MapRegisterCacheMetadataContainer arg)
Construct a new builder initialized from specifiedMapRegisterCacheMetadataContainer
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull MapRegisterCacheValue
build()
A newMapRegisterCacheValue
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MappingAuthkey
getMappingAuthkey()
Return current value associated with the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
.MapRegisterCacheMetadata
getMapRegisterCacheMetadata()
Return current value associated with the property corresponding toMapRegisterCacheMetadataContainer.getMapRegisterCacheMetadata()
.byte[]
getPacketData()
Return current value associated with the property corresponding toMapRegisterCacheValue.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)
Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.MapRegisterCacheValueBuilder
setMapRegisterCacheMetadata(MapRegisterCacheMetadata value)
Set the property corresponding toMapRegisterCacheMetadataContainer.getMapRegisterCacheMetadata()
to the specified value.MapRegisterCacheValueBuilder
setPacketData(byte[] value)
Set the property corresponding toMapRegisterCacheValue.getPacketData()
to the specified value.
-
-
-
Constructor Detail
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder()
Construct an empty builder.
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder(MapRegisterCacheMetadataContainer arg)
Construct a new builder initialized from specifiedMapRegisterCacheMetadataContainer
.- Parameters:
arg
- MapRegisterCacheMetadataContainer from which the builder should be initialized
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder(MappingAuthkeyContainer arg)
Construct a new builder initialized from specifiedMappingAuthkeyContainer
.- Parameters:
arg
- MappingAuthkeyContainer from which the builder should be initialized
-
MapRegisterCacheValueBuilder
public MapRegisterCacheValueBuilder(MapRegisterCacheValue base)
Construct a builder initialized with state from specifiedMapRegisterCacheValue
.- Parameters:
base
- MapRegisterCacheValue from which the builder should be initialized
-
-
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:- 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()
Return current value associated with the property corresponding toMapRegisterCacheMetadataContainer.getMapRegisterCacheMetadata()
.- Returns:
- current value
-
getMappingAuthkey
public MappingAuthkey getMappingAuthkey()
Return current value associated with the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
.- Returns:
- current value
-
getPacketData
public byte[] getPacketData()
Return current value associated with the property corresponding toMapRegisterCacheValue.getPacketData()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheValue>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setMapRegisterCacheMetadata
public MapRegisterCacheValueBuilder setMapRegisterCacheMetadata(MapRegisterCacheMetadata value)
Set the property corresponding toMapRegisterCacheMetadataContainer.getMapRegisterCacheMetadata()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappingAuthkey
public MapRegisterCacheValueBuilder setMappingAuthkey(MappingAuthkey value)
Set the property corresponding toMappingAuthkeyContainer.getMappingAuthkey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketData
public MapRegisterCacheValueBuilder setPacketData(byte[] value)
Set the property corresponding toMapRegisterCacheValue.getPacketData()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull MapRegisterCacheValue build()
A newMapRegisterCacheValue
instance.- Returns:
- A new
MapRegisterCacheValue
instance.
-
-