Class DestinationPortRangeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.packet.fields.rev160218.acl.transport.header.fields.DestinationPortRangeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<DestinationPortRange>
,org.opendaylight.yangtools.concepts.CheckedBuilder<DestinationPortRange,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DestinationPortRangeBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<DestinationPortRange>
Class that buildsDestinationPortRangeBuilder
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:
DestinationPortRangeBuilder createTarget(int fooXyzzy, int barBaz) { return new DestinationPortRangeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DestinationPortRangeBuilder, 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:
DestinationPortRangeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DestinationPortRangeBuilder()
DestinationPortRangeBuilder(DestinationPortRange base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DestinationPortRangeBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.DestinationPortRangeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
DestinationPortRange
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getLowerPort()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getUpperPort()
DestinationPortRangeBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange>> augmentationType)
Remove an augmentation from this builder's product.DestinationPortRangeBuilder
setLowerPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
DestinationPortRangeBuilder
setUpperPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
-
-
Constructor Detail
-
DestinationPortRangeBuilder
public DestinationPortRangeBuilder()
-
DestinationPortRangeBuilder
public DestinationPortRangeBuilder(DestinationPortRange base)
-
-
Method Detail
-
getLowerPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getLowerPort()
-
getUpperPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getUpperPort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setLowerPort
public DestinationPortRangeBuilder setLowerPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
setUpperPort
public DestinationPortRangeBuilder setUpperPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
addAugmentation
public DestinationPortRangeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public DestinationPortRangeBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange> 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 DestinationPortRangeBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationPortRange>> 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 DestinationPortRange build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<DestinationPortRange>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<DestinationPortRange,java.lang.IllegalArgumentException>
-
-