Class SetOriginatorIdPrependBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.set.originator.id.prepend.SetOriginatorIdPrependBuilder
-
@Generated("mdsal-binding-generator") public class SetOriginatorIdPrependBuilder extends Object
Class that buildsSetOriginatorIdPrepend
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:
SetOriginatorIdPrepend createSetOriginatorIdPrepend(int fooXyzzy, int barBaz) { return new SetOriginatorIdPrependBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetOriginatorIdPrepend, 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:
SetOriginatorIdPrepend
- 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 SetOriginatorIdPrependBuilder()
Construct an empty builder.SetOriginatorIdPrependBuilder(SetOriginatorIdPrepend base)
Construct a builder initialized with state from specifiedSetOriginatorIdPrepend
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetOriginatorIdPrependBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetOriginatorIdPrepend> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetOriginatorIdPrepend>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SetOriginatorIdPrepend
build()
A newSetOriginatorIdPrepend
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getOriginatorId()
Return current value associated with the property corresponding toSetOriginatorIdPrepend.getOriginatorId()
.SetOriginatorIdPrependBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetOriginatorIdPrepend>> augmentationType)
Remove an augmentation from this builder's product.SetOriginatorIdPrependBuilder
setOriginatorId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
Set the property corresponding toSetOriginatorIdPrepend.getOriginatorId()
to the specified value.
-
-
-
Constructor Detail
-
SetOriginatorIdPrependBuilder
public SetOriginatorIdPrependBuilder()
Construct an empty builder.
-
SetOriginatorIdPrependBuilder
public SetOriginatorIdPrependBuilder(SetOriginatorIdPrepend base)
Construct a builder initialized with state from specifiedSetOriginatorIdPrepend
.- Parameters:
base
- SetOriginatorIdPrepend from which the builder should be initialized
-
-
Method Detail
-
getOriginatorId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getOriginatorId()
Return current value associated with the property corresponding toSetOriginatorIdPrepend.getOriginatorId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetOriginatorIdPrepend>> 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
-
setOriginatorId
public SetOriginatorIdPrependBuilder setOriginatorId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
Set the property corresponding toSetOriginatorIdPrepend.getOriginatorId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetOriginatorIdPrependBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetOriginatorIdPrepend> 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 SetOriginatorIdPrependBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetOriginatorIdPrepend>> 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 SetOriginatorIdPrepend build()
A newSetOriginatorIdPrepend
instance.- Returns:
- A new
SetOriginatorIdPrepend
instance.
-
-