Class TypesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.flowspec.flowspec.type.icmp.type._case.TypesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Types>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Types,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TypesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Types>
Class that buildsTypesBuilder
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:
TypesBuilder createTarget(int fooXyzzy, int barBaz) { return new TypesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TypesBuilder, 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:
TypesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TypesBuilder()
TypesBuilder(Types base)
TypesBuilder(NumericOneByteValue arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TypesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Types> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Types>>
E$$augmentation(Class<E$$> augmentationType)
Types
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()
TypesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Types>> augmentationType)
Remove an augmentation from this builder's product.TypesBuilder
setOp(NumericOperand value)
TypesBuilder
setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetValue(Uint8)
instead.TypesBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
TypesBuilder
public TypesBuilder()
-
TypesBuilder
public TypesBuilder(NumericOneByteValue arg)
-
TypesBuilder
public TypesBuilder(Types 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<Types>> E$$ augmentation(Class<E$$> augmentationType)
-
setOp
public TypesBuilder setOp(NumericOperand value)
-
setValue
public TypesBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
@Deprecated(forRemoval=true) public TypesBuilder 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 TypesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Types> 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 TypesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Types>> 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 Types build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Types>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Types,IllegalArgumentException>
-
-