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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OriginatorIdSet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OriginatorIdSet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OriginatorIdSetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OriginatorIdSet>
Class that buildsOriginatorIdSetBuilder
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:
OriginatorIdSetBuilder createTarget(int fooXyzzy, int barBaz) { return new OriginatorIdSetBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OriginatorIdSetBuilder, 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 oportunities, 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:
OriginatorIdSetBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OriginatorIdSetBuilder()
OriginatorIdSetBuilder(OriginatorIdSet base)
-
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)
OriginatorIdSet
build()
Local
getLocal()
List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone>
getOriginatorId()
String
getOriginatorIdSetName()
OriginatorIdSetKey
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)
OriginatorIdSetBuilder
setOriginatorId(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> values)
OriginatorIdSetBuilder
setOriginatorIdSetName(String value)
OriginatorIdSetBuilder
withKey(OriginatorIdSetKey key)
-
-
-
Constructor Detail
-
OriginatorIdSetBuilder
public OriginatorIdSetBuilder()
-
OriginatorIdSetBuilder
public OriginatorIdSetBuilder(OriginatorIdSet base)
-
-
Method Detail
-
key
public OriginatorIdSetKey key()
-
getLocal
public Local getLocal()
-
getOriginatorId
public List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> getOriginatorId()
-
getOriginatorIdSetName
public String getOriginatorIdSetName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginatorIdSet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public OriginatorIdSetBuilder withKey(OriginatorIdSetKey key)
-
setLocal
public OriginatorIdSetBuilder setLocal(Local value)
-
setOriginatorId
public OriginatorIdSetBuilder setOriginatorId(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone> values)
-
setOriginatorIdSetName
public OriginatorIdSetBuilder setOriginatorIdSetName(String value)
-
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 OriginatorIdSet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OriginatorIdSet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OriginatorIdSet,IllegalArgumentException>
-
-