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