Class OriginatorIdBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.OriginatorIdBuilder
Class that builds
OriginatorId
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:
OriginatorId createOriginatorId(int fooXyzzy, int barBaz) {
return new OriginatorIdBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of OriginatorId, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedOriginatorId
.Construct a builder initialized with state from specifiedOriginatorId
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<OriginatorId> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginatorId>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull OriginatorId
build()
A newOriginatorId
instance.static @NonNull OriginatorId
empty()
Get empty instance of OriginatorId.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.inet.types.rev130715.Ipv4AddressNoZone
Return current value associated with the property corresponding toOriginatorId.getOriginator()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginatorId>> augmentationType) Remove an augmentation from this builder's product.setOriginator
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toOriginatorId.getOriginator()
to the specified value.
-
Constructor Details
-
OriginatorIdBuilder
public OriginatorIdBuilder()Construct an empty builder. -
OriginatorIdBuilder
Construct a new builder initialized from specifiedOriginatorId
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OriginatorId from which the builder should be initialized
-
OriginatorIdBuilder
Construct a builder initialized with state from specifiedOriginatorId
.- Parameters:
base
- OriginatorId from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of OriginatorId.- Returns:
- An empty
OriginatorId
-
getOriginator
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getOriginator()Return current value associated with the property corresponding toOriginatorId.getOriginator()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginatorId>> 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
-
setOriginator
public OriginatorIdBuilder setOriginator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toOriginatorId.getOriginator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public OriginatorIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OriginatorId> 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 OriginatorIdBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OriginatorId>> 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
A newOriginatorId
instance.- Returns:
- A new
OriginatorId
instance.
-