Class EthernetMatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EthernetMatch>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EthernetMatch,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class EthernetMatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<EthernetMatch>
Class that buildsEthernetMatchBuilder
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:
EthernetMatchBuilder createTarget(int fooXyzzy, int barBaz) { return new EthernetMatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EthernetMatchBuilder, 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:
EthernetMatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EthernetMatchBuilder()
EthernetMatchBuilder(EthernetMatchFields arg)
EthernetMatchBuilder(EthernetMatch base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EthernetMatchBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>>
E$$augmentation(Class<E$$> augmentationType)
EthernetMatch
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EthernetDestination
getEthernetDestination()
EthernetSource
getEthernetSource()
EthernetType
getEthernetType()
EthernetMatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> augmentationType)
EthernetMatchBuilder
setEthernetDestination(EthernetDestination value)
EthernetMatchBuilder
setEthernetSource(EthernetSource value)
EthernetMatchBuilder
setEthernetType(EthernetType value)
-
-
-
Constructor Detail
-
EthernetMatchBuilder
public EthernetMatchBuilder()
-
EthernetMatchBuilder
public EthernetMatchBuilder(EthernetMatchFields arg)
-
EthernetMatchBuilder
public EthernetMatchBuilder(EthernetMatch 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.model.match.types.rev131026.EthernetMatchFields
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getEthernetDestination
public EthernetDestination getEthernetDestination()
-
getEthernetSource
public EthernetSource getEthernetSource()
-
getEthernetType
public EthernetType getEthernetType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> E$$ augmentation(Class<E$$> augmentationType)
-
setEthernetDestination
public EthernetMatchBuilder setEthernetDestination(EthernetDestination value)
-
setEthernetSource
public EthernetMatchBuilder setEthernetSource(EthernetSource value)
-
setEthernetType
public EthernetMatchBuilder setEthernetType(EthernetType value)
-
addAugmentation
public EthernetMatchBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch> augmentationValue)
-
removeAugmentation
public EthernetMatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetMatch>> augmentationType)
-
build
public EthernetMatch build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EthernetMatch>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EthernetMatch,IllegalArgumentException>
-
-