Class MacBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.MacBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Mac>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Mac,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MacBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Mac>
Class that buildsMac
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:
Mac createMac(int fooXyzzy, int barBaz) { return new MacBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Mac, 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:
Mac
,Builder
-
-
Constructor Summary
Constructors Constructor Description MacBuilder()
MacBuilder(Mac base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MacBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Mac> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mac>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Mac
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getMac()
MacBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mac>> augmentationType)
Remove an augmentation from this builder's product.MacBuilder
setMac(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
-
-
Constructor Detail
-
MacBuilder
public MacBuilder()
-
MacBuilder
public MacBuilder(Mac base)
-
-
Method Detail
-
getMac
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMac()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Mac>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setMac
public MacBuilder setMac(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
addAugmentation
public MacBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Mac> 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 MacBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Mac>> 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
-
-