Class LdpMpOpaqueValueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.multicast.group.opaque.grouping.multicast.group.ldp.mp.opaque.value._case.LdpMpOpaqueValueBuilder
-
@Generated("mdsal-binding-generator") public class LdpMpOpaqueValueBuilder extends Object
Class that buildsLdpMpOpaqueValue
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:
LdpMpOpaqueValue createLdpMpOpaqueValue(int fooXyzzy, int barBaz) { return new LdpMpOpaqueValueBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LdpMpOpaqueValue, 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:
LdpMpOpaqueValue
- 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 LdpMpOpaqueValueBuilder()
Construct an empty builder.LdpMpOpaqueValueBuilder(LdpMpOpaqueValue base)
Construct a builder initialized with state from specifiedLdpMpOpaqueValue
.LdpMpOpaqueValueBuilder(Opaque arg)
Construct a new builder initialized from specifiedOpaque
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LdpMpOpaqueValueBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LdpMpOpaqueValue> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LdpMpOpaqueValue>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LdpMpOpaqueValue
build()
A newLdpMpOpaqueValue
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString
getOpaque()
Return current value associated with the property corresponding toOpaque.getOpaque()
.org.opendaylight.yangtools.yang.common.Uint16
getOpaqueExtendedType()
Return current value associated with the property corresponding toOpaque.getOpaqueExtendedType()
.org.opendaylight.yangtools.yang.common.Uint8
getOpaqueType()
Return current value associated with the property corresponding toOpaque.getOpaqueType()
.LdpMpOpaqueValueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LdpMpOpaqueValue>> augmentationType)
Remove an augmentation from this builder's product.LdpMpOpaqueValueBuilder
setOpaque(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString value)
Set the property corresponding toOpaque.getOpaque()
to the specified value.LdpMpOpaqueValueBuilder
setOpaqueExtendedType(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOpaque.getOpaqueExtendedType()
to the specified value.LdpMpOpaqueValueBuilder
setOpaqueType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOpaque.getOpaqueType()
to the specified value.
-
-
-
Constructor Detail
-
LdpMpOpaqueValueBuilder
public LdpMpOpaqueValueBuilder()
Construct an empty builder.
-
LdpMpOpaqueValueBuilder
public LdpMpOpaqueValueBuilder(Opaque arg)
Construct a new builder initialized from specifiedOpaque
.- Parameters:
arg
- Opaque from which the builder should be initialized
-
LdpMpOpaqueValueBuilder
public LdpMpOpaqueValueBuilder(LdpMpOpaqueValue base)
Construct a builder initialized with state from specifiedLdpMpOpaqueValue
.- Parameters:
base
- LdpMpOpaqueValue 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:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getOpaque
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString getOpaque()
Return current value associated with the property corresponding toOpaque.getOpaque()
.- Returns:
- current value
-
getOpaqueExtendedType
public org.opendaylight.yangtools.yang.common.Uint16 getOpaqueExtendedType()
Return current value associated with the property corresponding toOpaque.getOpaqueExtendedType()
.- Returns:
- current value
-
getOpaqueType
public org.opendaylight.yangtools.yang.common.Uint8 getOpaqueType()
Return current value associated with the property corresponding toOpaque.getOpaqueType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LdpMpOpaqueValue>> E$$ augmentation(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:
NullPointerException
- ifaugmentType
isnull
-
setOpaque
public LdpMpOpaqueValueBuilder setOpaque(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString value)
Set the property corresponding toOpaque.getOpaque()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOpaqueExtendedType
public LdpMpOpaqueValueBuilder setOpaqueExtendedType(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toOpaque.getOpaqueExtendedType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOpaqueType
public LdpMpOpaqueValueBuilder setOpaqueType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOpaque.getOpaqueType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LdpMpOpaqueValueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LdpMpOpaqueValue> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public LdpMpOpaqueValueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LdpMpOpaqueValue>> 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 LdpMpOpaqueValue build()
A newLdpMpOpaqueValue
instance.- Returns:
- A new
LdpMpOpaqueValue
instance.
-
-