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