Class LoopbackBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.LoopbackBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Loopback>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Loopback,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LoopbackBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Loopback>
Class that buildsLoopbackBuilder
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:
LoopbackBuilder createTarget(int fooXyzzy, int barBaz) { return new LoopbackBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LoopbackBuilder, 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:
LoopbackBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LoopbackBuilder()
LoopbackBuilder(Loopback base)
LoopbackBuilder(LoopbackInterfaceBaseAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoopbackBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Loopback> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Loopback>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Loopback
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress
getMac()
LoopbackBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Loopback>> augmentationType)
Remove an augmentation from this builder's product.LoopbackBuilder
setMac(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress value)
-
-
-
Constructor Detail
-
LoopbackBuilder
public LoopbackBuilder()
-
LoopbackBuilder
public LoopbackBuilder(LoopbackInterfaceBaseAttributes arg)
-
LoopbackBuilder
public LoopbackBuilder(Loopback 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.LoopbackInterfaceBaseAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMac
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress getMac()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Loopback>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setMac
public LoopbackBuilder setMac(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress value)
-
addAugmentation
public LoopbackBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Loopback> 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 LoopbackBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Loopback>> 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
-
-