Class CodesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.flowspec.flowspec.type.icmp.code._case.CodesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Codes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Codes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class CodesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Codes>
Class that buildsCodesBuilder
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:
CodesBuilder createTarget(int fooXyzzy, int barBaz) { return new CodesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CodesBuilder, 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:
CodesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CodesBuilder()
CodesBuilder(Codes base)
CodesBuilder(NumericOneByteValue arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CodesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Codes>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Codes> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Codes>>
E$$augmentation(Class<E$$> augmentationType)
Codes
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()
CodesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Codes>> augmentationType)
CodesBuilder
setOp(NumericOperand value)
CodesBuilder
setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint8)} instead.CodesBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
CodesBuilder
public CodesBuilder()
-
CodesBuilder
public CodesBuilder(NumericOneByteValue arg)
-
CodesBuilder
public CodesBuilder(Codes 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
-
getOp
public NumericOperand getOp()
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Codes>> E$$ augmentation(Class<E$$> augmentationType)
-
setOp
public CodesBuilder setOp(NumericOperand value)
-
setValue
public CodesBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
@Deprecated(forRemoval=true) public CodesBuilder setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public CodesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Codes>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Codes> augmentationValue)
-
removeAugmentation
public CodesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Codes>> augmentationType)
-
build
public Codes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Codes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Codes,IllegalArgumentException>
-
-