Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields
Class EthernetDestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetDestinationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EthernetDestination>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EthernetDestination,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class EthernetDestinationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<EthernetDestination>
Class that buildsEthernetDestinationBuilder
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:
EthernetDestinationBuilder createTarget(int fooXyzzy, int barBaz) { return new EthernetDestinationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EthernetDestinationBuilder, 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:
EthernetDestinationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EthernetDestinationBuilder()
EthernetDestinationBuilder(EthernetDestination base)
EthernetDestinationBuilder(MacAddressFilter arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EthernetDestinationBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination>>
E$$augmentation(Class<E$$> augmentationType)
EthernetDestination
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.MacAddress
getAddress()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getMask()
EthernetDestinationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination>> augmentationType)
EthernetDestinationBuilder
setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
EthernetDestinationBuilder
setMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
-
-
Constructor Detail
-
EthernetDestinationBuilder
public EthernetDestinationBuilder()
-
EthernetDestinationBuilder
public EthernetDestinationBuilder(MacAddressFilter arg)
-
EthernetDestinationBuilder
public EthernetDestinationBuilder(EthernetDestination 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.MacAddressFilter
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getAddress()
-
getMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMask()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination>> E$$ augmentation(Class<E$$> augmentationType)
-
setAddress
public EthernetDestinationBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
setMask
public EthernetDestinationBuilder setMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
-
addAugmentation
public EthernetDestinationBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination> augmentationValue)
-
removeAugmentation
public EthernetDestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetDestination>> augmentationType)
-
build
public EthernetDestination build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EthernetDestination>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EthernetDestination,IllegalArgumentException>
-
-