Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields
Class EthernetTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EthernetType>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EthernetType,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class EthernetTypeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<EthernetType>
Class that buildsEthernetTypeBuilder
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:
EthernetTypeBuilder createTarget(int fooXyzzy, int barBaz) { return new EthernetTypeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EthernetTypeBuilder, 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:
EthernetTypeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EthernetTypeBuilder()
EthernetTypeBuilder(EthernetType base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EthernetTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthernetType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetType>>
E$$augmentation(Class<E$$> augmentationType)
EthernetType
build()
org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType
getType()
EthernetTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetType>> augmentationType)
Remove an augmentation from this builder's product.EthernetTypeBuilder
setType(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType value)
-
-
-
Constructor Detail
-
EthernetTypeBuilder
public EthernetTypeBuilder()
-
EthernetTypeBuilder
public EthernetTypeBuilder(EthernetType base)
-
-
Method Detail
-
getType
public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetType>> E$$ augmentation(Class<E$$> augmentationType)
-
setType
public EthernetTypeBuilder setType(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType value)
-
addAugmentation
public EthernetTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthernetType> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public EthernetTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetType>> 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 EthernetType build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EthernetType>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EthernetType,IllegalArgumentException>
-
-