Class UdpSrcBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.udp.src._case.UdpSrcBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UdpSrc>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UdpSrc,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class UdpSrcBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UdpSrc>
Class that buildsUdpSrcBuilder
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:
UdpSrcBuilder createTarget(int fooXyzzy, int barBaz) { return new UdpSrcBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UdpSrcBuilder, 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:
UdpSrcBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description UdpSrcBuilder()
UdpSrcBuilder(UdpSrc base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description UdpSrcBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.UdpSrcBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc>>
E$$augmentation(Class<E$$> augmentationType)
UdpSrc
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getPort()
UdpSrcBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc>> augmentationType)
Remove an augmentation from this builder's product.UdpSrcBuilder
setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
-
-
Constructor Detail
-
UdpSrcBuilder
public UdpSrcBuilder()
-
UdpSrcBuilder
public UdpSrcBuilder(UdpSrc base)
-
-
Method Detail
-
getPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc>> E$$ augmentation(Class<E$$> augmentationType)
-
setPort
public UdpSrcBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
addAugmentation
public UdpSrcBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public UdpSrcBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public UdpSrcBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UdpSrc>> 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 UdpSrc build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UdpSrc>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UdpSrc,IllegalArgumentException>
-
-