Class TapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces.state._interface.TapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Tap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Tap,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TapBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Tap>
Class that buildsTapBuilder
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:
TapBuilder createTarget(int fooXyzzy, int barBaz) { return new TapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TapBuilder, 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:
TapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TapBuilder()
TapBuilder(Tap base)
TapBuilder(InterfaceTag arg)
TapBuilder(TapInterfaceBaseAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TapBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tap>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Tap> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.TapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tap>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Tap
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.String
getTag()
java.lang.String
getTapName()
TapBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tap>> augmentationType)
Remove an augmentation from this builder's product.TapBuilder
setTag(java.lang.String value)
TapBuilder
setTapName(java.lang.String value)
-
-
-
Constructor Detail
-
TapBuilder
public TapBuilder()
-
TapBuilder
public TapBuilder(TapInterfaceBaseAttributes arg)
-
TapBuilder
public TapBuilder(InterfaceTag arg)
-
TapBuilder
public TapBuilder(Tap 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.params.xml.ns.yang.v3po.rev170607.TapInterfaceBaseAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.InterfaceTag
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getTag
public java.lang.String getTag()
-
getTapName
public java.lang.String getTapName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Tap>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setTag
public TapBuilder setTag(java.lang.String value)
-
setTapName
public TapBuilder setTapName(java.lang.String value)
-
addAugmentation
public TapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Tap> 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 TapBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tap>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Tap> 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 TapBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Tap>> 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
-
-