Class IpProtoBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ip.proto._case.IpProtoBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpProto>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpProto,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IpProtoBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IpProto>
Class that buildsIpProtoBuilder
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:
IpProtoBuilder createTarget(int fooXyzzy, int barBaz) { return new IpProtoBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpProtoBuilder, 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:
IpProtoBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpProtoBuilder()
IpProtoBuilder(IpProto base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IpProtoBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProto>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpProto> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProto>>
E$$augmentation(Class<E$$> augmentationType)
IpProto
build()
org.opendaylight.yangtools.yang.common.Uint8
getProtocolNumber()
IpProtoBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProto>> augmentationType)
IpProtoBuilder
setProtocolNumber(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProtocolNumber(Uint8)} instead.IpProtoBuilder
setProtocolNumber(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
IpProtoBuilder
public IpProtoBuilder()
-
IpProtoBuilder
public IpProtoBuilder(IpProto base)
-
-
Method Detail
-
getProtocolNumber
public org.opendaylight.yangtools.yang.common.Uint8 getProtocolNumber()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProto>> E$$ augmentation(Class<E$$> augmentationType)
-
setProtocolNumber
public IpProtoBuilder setProtocolNumber(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setProtocolNumber
@Deprecated(forRemoval=true) public IpProtoBuilder setProtocolNumber(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProtocolNumber(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public IpProtoBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProto>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpProto> augmentationValue)
-
removeAugmentation
public IpProtoBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpProto>> augmentationType)
-
build
public IpProto build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpProto>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpProto,IllegalArgumentException>
-
-