Class EidLispAddressBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.map.register.cache.metadata.EidLispAddressBuilder
Class that builds
EidLispAddress
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:
EidLispAddress createEidLispAddress(int fooXyzzy, int barBaz) {
return new EidLispAddressBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of EidLispAddress, 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 specifiedEidContainer
.Construct a builder initialized with state from specifiedEidLispAddress
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull EidLispAddress
build()
A newEidLispAddress
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getEid()
Return current value associated with the property corresponding toEidContainer.getEid()
.Return current value associated with the property corresponding toEidLispAddress.getEidLispAddressId()
.key()
Return current value associated with the property corresponding toEidLispAddress.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toEidContainer.getEid()
to the specified value.setEidLispAddressId
(String value) Set the property corresponding toEidLispAddress.getEidLispAddressId()
to the specified value.withKey
(EidLispAddressKey key) Set the key value corresponding toEidLispAddress.key()
to the specified value.
-
Constructor Details
-
EidLispAddressBuilder
public EidLispAddressBuilder()Construct an empty builder. -
EidLispAddressBuilder
Construct a new builder initialized from specifiedEidContainer
.- Parameters:
arg
- EidContainer from which the builder should be initialized
-
EidLispAddressBuilder
Construct a builder initialized with state from specifiedEidLispAddress
.- Parameters:
base
- EidLispAddress 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
-
key
Return current value associated with the property corresponding toEidLispAddress.key()
.- Returns:
- current value
-
getEid
Return current value associated with the property corresponding toEidContainer.getEid()
.- Returns:
- current value
-
getEidLispAddressId
Return current value associated with the property corresponding toEidLispAddress.getEidLispAddressId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>> 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
Set the key value corresponding toEidLispAddress.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setEid
Set the property corresponding toEidContainer.getEid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEidLispAddressId
Set the property corresponding toEidLispAddress.getEidLispAddressId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EidLispAddressBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress> 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 EidLispAddressBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>> 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 newEidLispAddress
instance.- Returns:
- A new
EidLispAddress
instance.
-