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