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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SubscriberData>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SubscriberData,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SubscriberDataBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<SubscriberData>
Class that buildsSubscriberDataBuilder
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:
SubscriberDataBuilder createTarget(int fooXyzzy, int barBaz) { return new SubscriberDataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubscriberDataBuilder, 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:
SubscriberDataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SubscriberDataBuilder()
SubscriberDataBuilder(EidContainer arg)
SubscriberDataBuilder(RlocContainer arg)
SubscriberDataBuilder(SubscriberData base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SubscriberDataBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
SubscriberData
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Eid
getEid()
Rloc
getRloc()
java.lang.Integer
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)
SubscriberDataBuilder
setRloc(Rloc value)
SubscriberDataBuilder
setTtl(java.lang.Integer value)
-
-
-
Constructor Detail
-
SubscriberDataBuilder
public SubscriberDataBuilder()
-
SubscriberDataBuilder
public SubscriberDataBuilder(RlocContainer arg)
-
SubscriberDataBuilder
public SubscriberDataBuilder(EidContainer arg)
-
SubscriberDataBuilder
public SubscriberDataBuilder(SubscriberData 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
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.RlocContainer
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getEid
public Eid getEid()
-
getRloc
public Rloc getRloc()
-
getTtl
public java.lang.Integer getTtl()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEid
public SubscriberDataBuilder setEid(Eid value)
-
setRloc
public SubscriberDataBuilder setRloc(Rloc value)
-
setTtl
public SubscriberDataBuilder setTtl(java.lang.Integer value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public SubscriberDataBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberData> 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 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 SubscriberData build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SubscriberData>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SubscriberData,java.lang.IllegalArgumentException>
-
-