Class IcmpCodeCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.flowspec.flowspec.type.IcmpCodeCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IcmpCodeCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IcmpCodeCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IcmpCodeCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IcmpCodeCase>
Class that buildsIcmpCodeCase
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:
IcmpCodeCase createIcmpCodeCase(int fooXyzzy, int barBaz) { return new IcmpCodeCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IcmpCodeCase, 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 opportunities, 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:
IcmpCodeCase
,Builder
-
-
Constructor Summary
Constructors Constructor Description IcmpCodeCaseBuilder()
IcmpCodeCaseBuilder(IcmpCodeCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IcmpCodeCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IcmpCodeCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpCodeCase>>
E$$augmentation(Class<E$$> augmentationType)
IcmpCodeCase
build()
List<Codes>
getCodes()
IcmpCodeCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpCodeCase>> augmentationType)
Remove an augmentation from this builder's product.IcmpCodeCaseBuilder
setCodes(List<Codes> values)
-
-
-
Constructor Detail
-
IcmpCodeCaseBuilder
public IcmpCodeCaseBuilder()
-
IcmpCodeCaseBuilder
public IcmpCodeCaseBuilder(IcmpCodeCase base)
-
-
Method Detail
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpCodeCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setCodes
public IcmpCodeCaseBuilder setCodes(List<Codes> values)
-
addAugmentation
public IcmpCodeCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IcmpCodeCase> 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 IcmpCodeCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IcmpCodeCase>> 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 IcmpCodeCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IcmpCodeCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IcmpCodeCase,IllegalArgumentException>
-
-