Class SubscriberItemBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.changed.SubscriberItemBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SubscriberItem>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SubscriberItem,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SubscriberItemBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<SubscriberItem>
Class that buildsSubscriberItemBuilder
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:
SubscriberItemBuilder createTarget(int fooXyzzy, int barBaz) { return new SubscriberItemBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubscriberItemBuilder, 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:
SubscriberItemBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SubscriberItemBuilder()
SubscriberItemBuilder(SubscriberDataGrouping arg)
SubscriberItemBuilder(SubscriberItem base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SubscriberItemBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.SubscriberItemBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
SubscriberItem
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.SubscriberData
getSubscriberData()
SubscriberItemBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem>> augmentationType)
Remove an augmentation from this builder's product.SubscriberItemBuilder
setSubscriberData(SubscriberData value)
-
-
-
Constructor Detail
-
SubscriberItemBuilder
public SubscriberItemBuilder()
-
SubscriberItemBuilder
public SubscriberItemBuilder(SubscriberDataGrouping arg)
-
SubscriberItemBuilder
public SubscriberItemBuilder(SubscriberItem 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.SubscriberDataGrouping
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getSubscriberData
public SubscriberData getSubscriberData()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setSubscriberData
public SubscriberItemBuilder setSubscriberData(SubscriberData value)
-
addAugmentation
public SubscriberItemBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem> 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 SubscriberItemBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem> 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 SubscriberItemBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubscriberItem>> 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 SubscriberItem build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SubscriberItem>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SubscriberItem,java.lang.IllegalArgumentException>
-
-