Class PacketTypeCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.PacketTypeCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PacketTypeCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PacketTypeCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PacketTypeCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketTypeCase>
Class that buildsPacketTypeCaseBuilder
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:
PacketTypeCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new PacketTypeCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketTypeCaseBuilder, 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:
PacketTypeCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketTypeCaseBuilder()
PacketTypeCaseBuilder(PacketTypeCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PacketTypeCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketTypeCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketTypeCase>>
E$$augmentation(Class<E$$> augmentationType)
PacketTypeCase
build()
PacketType
getPacketType()
PacketTypeCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketTypeCase>> augmentationType)
Remove an augmentation from this builder's product.PacketTypeCaseBuilder
setPacketType(PacketType value)
-
-
-
Constructor Detail
-
PacketTypeCaseBuilder
public PacketTypeCaseBuilder()
-
PacketTypeCaseBuilder
public PacketTypeCaseBuilder(PacketTypeCase base)
-
-
Method Detail
-
getPacketType
public PacketType getPacketType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketTypeCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setPacketType
public PacketTypeCaseBuilder setPacketType(PacketType value)
-
addAugmentation
public PacketTypeCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketTypeCase> 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 PacketTypeCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketTypeCase>> 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 PacketTypeCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketTypeCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketTypeCase,IllegalArgumentException>
-
-