Class ProtocolIpsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.group.ipv4.flowspec.flowspec.type.protocol.ip._case.ProtocolIpsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ProtocolIps>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ProtocolIps,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ProtocolIpsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ProtocolIps>
Class that buildsProtocolIpsBuilder
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:
ProtocolIpsBuilder createTarget(int fooXyzzy, int barBaz) { return new ProtocolIpsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProtocolIpsBuilder, 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:
ProtocolIpsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ProtocolIpsBuilder()
ProtocolIpsBuilder(ProtocolIps base)
ProtocolIpsBuilder(NumericOneByteValue arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ProtocolIpsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolIps> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolIps>>
E$$augmentation(Class<E$$> augmentationType)
ProtocolIps
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NumericOperand
getOp()
org.opendaylight.yangtools.yang.common.Uint8
getValue()
ProtocolIpsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolIps>> augmentationType)
Remove an augmentation from this builder's product.ProtocolIpsBuilder
setOp(NumericOperand value)
ProtocolIpsBuilder
setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint8)
instead.ProtocolIpsBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
ProtocolIpsBuilder
public ProtocolIpsBuilder()
-
ProtocolIpsBuilder
public ProtocolIpsBuilder(NumericOneByteValue arg)
-
ProtocolIpsBuilder
public ProtocolIpsBuilder(ProtocolIps 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.params.xml.ns.yang.bgp.flowspec.rev200120.NumericOneByteValue
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getOp
public NumericOperand getOp()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolIps>> E$$ augmentation(Class<E$$> augmentationType)
-
setOp
public ProtocolIpsBuilder setOp(NumericOperand value)
-
setValue
public ProtocolIpsBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
@Deprecated(forRemoval=true) public ProtocolIpsBuilder setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public ProtocolIpsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolIps> 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 ProtocolIpsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtocolIps>> 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 ProtocolIps build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ProtocolIps>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ProtocolIps,IllegalArgumentException>
-
-