Class RlocBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.rloc.container.RlocBuilder
-
@Generated("mdsal-binding-generator") public class RlocBuilder extends java.lang.Object
Class that buildsRloc
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:
Rloc createRloc(int fooXyzzy, int barBaz) { return new RlocBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Rloc, 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:
Rloc
- 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 RlocBuilder()
Construct an empty builder.RlocBuilder(LispAddress arg)
Construct a new builder initialized from specifiedLispAddress
.RlocBuilder(AugmentedLispAddress arg)
Construct a new builder initialized from specifiedAugmentedLispAddress
.RlocBuilder(Rloc base)
Construct a builder initialized with state from specifiedRloc
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RlocBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Rloc> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rloc>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Rloc
build()
A newRloc
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Address
getAddress()
Return current value associated with the property corresponding toLispAddress.getAddress()
.java.lang.Class<? extends LispAddressFamily>
getAddressType()
Return current value associated with the property corresponding toLispAddress.getAddressType()
.InstanceIdType
getVirtualNetworkId()
Return current value associated with the property corresponding toLispAddress.getVirtualNetworkId()
.RlocBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rloc>> augmentationType)
Remove an augmentation from this builder's product.RlocBuilder
setAddress(Address value)
Set the property corresponding toLispAddress.getAddress()
to the specified value.RlocBuilder
setAddressType(java.lang.Class<? extends LispAddressFamily> value)
Set the property corresponding toLispAddress.getAddressType()
to the specified value.RlocBuilder
setVirtualNetworkId(InstanceIdType value)
Set the property corresponding toLispAddress.getVirtualNetworkId()
to the specified value.
-
-
-
Constructor Detail
-
RlocBuilder
public RlocBuilder()
Construct an empty builder.
-
RlocBuilder
public RlocBuilder(AugmentedLispAddress arg)
Construct a new builder initialized from specifiedAugmentedLispAddress
.- Parameters:
arg
- AugmentedLispAddress from which the builder should be initialized
-
RlocBuilder
public RlocBuilder(LispAddress arg)
Construct a new builder initialized from specifiedLispAddress
.- Parameters:
arg
- LispAddress from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAddress
public Address getAddress()
Return current value associated with the property corresponding toLispAddress.getAddress()
.- Returns:
- current value
-
getAddressType
public java.lang.Class<? extends LispAddressFamily> getAddressType()
Return current value associated with the property corresponding toLispAddress.getAddressType()
.- Returns:
- current value
-
getVirtualNetworkId
public InstanceIdType getVirtualNetworkId()
Return current value associated with the property corresponding toLispAddress.getVirtualNetworkId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rloc>> E$$ augmentation(java.lang.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:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setAddress
public RlocBuilder setAddress(Address value)
Set the property corresponding toLispAddress.getAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAddressType
public RlocBuilder setAddressType(java.lang.Class<? extends LispAddressFamily> value)
Set the property corresponding toLispAddress.getAddressType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVirtualNetworkId
public RlocBuilder setVirtualNetworkId(InstanceIdType value)
Set the property corresponding toLispAddress.getVirtualNetworkId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RlocBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Rloc> 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
-
removeAugmentation
public RlocBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rloc>> 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
-
-