Class EthernetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.EthernetBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ethernet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ethernet,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class EthernetBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ethernet>
Class that buildsEthernetBuilder
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:
EthernetBuilder createTarget(int fooXyzzy, int barBaz) { return new EthernetBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EthernetBuilder, 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:
EthernetBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EthernetBuilder()
EthernetBuilder(EthernetBaseAttributes arg)
EthernetBuilder(Ethernet base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description EthernetBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ethernet
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getMtu()
EthernetBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet>> augmentationType)
EthernetBuilder
setMtu(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMtu(Uint16)} instead.EthernetBuilder
setMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
EthernetBuilder
public EthernetBuilder()
-
EthernetBuilder
public EthernetBuilder(EthernetBaseAttributes arg)
-
EthernetBuilder
public EthernetBuilder(Ethernet 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.EthernetBaseAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getMtu
public org.opendaylight.yangtools.yang.common.Uint16 getMtu()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setMtu
public EthernetBuilder setMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMtu
@Deprecated(forRemoval=true) public EthernetBuilder setMtu(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMtu(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public EthernetBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet> augmentationValue)
-
removeAugmentation
public EthernetBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ethernet>> augmentationType)
-
-