Class OxmContainerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmContainerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OxmContainer>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OxmContainer,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OxmContainerBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OxmContainer>
Class that buildsOxmContainer
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:
OxmContainer createOxmContainer(int fooXyzzy, int barBaz) { return new OxmContainerBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OxmContainer, 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:
OxmContainer
,Builder
-
-
Constructor Summary
Constructors Constructor Description OxmContainerBuilder()
OxmContainerBuilder(MatchEntryValueGrouping arg)
OxmContainerBuilder(OxmContainer base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OxmContainerBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OxmContainer> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OxmContainer>>
E$$augmentation(Class<E$$> augmentationType)
OxmContainer
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MatchEntryValue
getMatchEntryValue()
OxmContainerBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OxmContainer>> augmentationType)
Remove an augmentation from this builder's product.OxmContainerBuilder
setMatchEntryValue(MatchEntryValue value)
-
-
-
Constructor Detail
-
OxmContainerBuilder
public OxmContainerBuilder()
-
OxmContainerBuilder
public OxmContainerBuilder(MatchEntryValueGrouping arg)
-
OxmContainerBuilder
public OxmContainerBuilder(OxmContainer 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:- MatchEntryValueGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMatchEntryValue
public MatchEntryValue getMatchEntryValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OxmContainer>> E$$ augmentation(Class<E$$> augmentationType)
-
setMatchEntryValue
public OxmContainerBuilder setMatchEntryValue(MatchEntryValue value)
-
addAugmentation
public OxmContainerBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OxmContainer> 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 OxmContainerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OxmContainer>> 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 OxmContainer build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OxmContainer>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OxmContainer,IllegalArgumentException>
-
-