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