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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EidLispAddress>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EidLispAddress,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class EidLispAddressBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<EidLispAddress>
Class that buildsEidLispAddressBuilder
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:
EidLispAddressBuilder createTarget(int fooXyzzy, int barBaz) { return new EidLispAddressBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EidLispAddressBuilder, 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:
EidLispAddressBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EidLispAddressBuilder()
EidLispAddressBuilder(EidContainer arg)
EidLispAddressBuilder(EidLispAddress base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description EidLispAddressBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.EidLispAddressBuilder
addAugmentation(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(java.lang.Class<E$$> augmentationType)
EidLispAddress
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Eid
getEid()
java.lang.String
getEidLispAddressId()
EidLispAddressKey
key()
EidLispAddressBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>> augmentationType)
Remove an augmentation from this builder's product.EidLispAddressBuilder
setEid(Eid value)
EidLispAddressBuilder
setEidLispAddressId(java.lang.String value)
EidLispAddressBuilder
withKey(EidLispAddressKey key)
-
-
-
Constructor Detail
-
EidLispAddressBuilder
public EidLispAddressBuilder()
-
EidLispAddressBuilder
public EidLispAddressBuilder(EidContainer arg)
-
EidLispAddressBuilder
public EidLispAddressBuilder(EidLispAddress base)
-
-
Method Detail
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.EidContainer
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
key
public EidLispAddressKey key()
-
getEid
public Eid getEid()
-
getEidLispAddressId
public java.lang.String getEidLispAddressId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public EidLispAddressBuilder withKey(EidLispAddressKey key)
-
setEid
public EidLispAddressBuilder setEid(Eid value)
-
setEidLispAddressId
public EidLispAddressBuilder setEidLispAddressId(java.lang.String value)
-
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:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public EidLispAddressBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EidLispAddress> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public EidLispAddressBuilder removeAugmentation(java.lang.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
public EidLispAddress build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EidLispAddress>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EidLispAddress,java.lang.IllegalArgumentException>
-
-