Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.subscriber.data.grouping
Class SubscriberDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.subscriber.data.grouping.SubscriberDataBuilder
-
@Generated("mdsal-binding-generator") public class SubscriberDataBuilder extends java.lang.Object
Class that buildsSubscriberData
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:
SubscriberData createSubscriberData(int fooXyzzy, int barBaz) { return new SubscriberDataBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubscriberData, 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:
SubscriberData
- 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 SubscriberDataBuilder()
Construct an empty builder.SubscriberDataBuilder(EidContainer arg)
Construct a new builder initialized from specifiedEidContainer
.SubscriberDataBuilder(RlocContainer arg)
Construct a new builder initialized from specifiedRlocContainer
.SubscriberDataBuilder(SubscriberData base)
Construct a builder initialized with state from specifiedSubscriberData
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubscriberDataBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SubscriberData
build()
A newSubscriberData
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Eid
getEid()
Return current value associated with the property corresponding toEidContainer.getEid()
.Rloc
getRloc()
Return current value associated with the property corresponding toRlocContainer.getRloc()
.java.lang.Integer
getTtl()
Return current value associated with the property corresponding toSubscriberData.getTtl()
.SubscriberDataBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData>> augmentationType)
Remove an augmentation from this builder's product.SubscriberDataBuilder
setEid(Eid value)
Set the property corresponding toEidContainer.getEid()
to the specified value.SubscriberDataBuilder
setRloc(Rloc value)
Set the property corresponding toRlocContainer.getRloc()
to the specified value.SubscriberDataBuilder
setTtl(java.lang.Integer value)
Set the property corresponding toSubscriberData.getTtl()
to the specified value.
-
-
-
Constructor Detail
-
SubscriberDataBuilder
public SubscriberDataBuilder()
Construct an empty builder.
-
SubscriberDataBuilder
public SubscriberDataBuilder(RlocContainer arg)
Construct a new builder initialized from specifiedRlocContainer
.- Parameters:
arg
- RlocContainer from which the builder should be initialized
-
SubscriberDataBuilder
public SubscriberDataBuilder(EidContainer arg)
Construct a new builder initialized from specifiedEidContainer
.- Parameters:
arg
- EidContainer from which the builder should be initialized
-
SubscriberDataBuilder
public SubscriberDataBuilder(SubscriberData base)
Construct a builder initialized with state from specifiedSubscriberData
.- Parameters:
base
- SubscriberData 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
-
getEid
public Eid getEid()
Return current value associated with the property corresponding toEidContainer.getEid()
.- Returns:
- current value
-
getRloc
public Rloc getRloc()
Return current value associated with the property corresponding toRlocContainer.getRloc()
.- Returns:
- current value
-
getTtl
public java.lang.Integer getTtl()
Return current value associated with the property corresponding toSubscriberData.getTtl()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData>> 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
-
setEid
public SubscriberDataBuilder setEid(Eid value)
Set the property corresponding toEidContainer.getEid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRloc
public SubscriberDataBuilder setRloc(Rloc value)
Set the property corresponding toRlocContainer.getRloc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTtl
public SubscriberDataBuilder setTtl(java.lang.Integer value)
Set the property corresponding toSubscriberData.getTtl()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SubscriberDataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData> 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 SubscriberDataBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData>> 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 @NonNull SubscriberData build()
A newSubscriberData
instance.- Returns:
- A new
SubscriberData
instance.
-
-