Class RouteMirroringMessageBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.RouteMirroringMessageBuilder
Class that builds
RouteMirroringMessage
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:
RouteMirroringMessage createRouteMirroringMessage(int fooXyzzy, int barBaz) {
return new RouteMirroringMessageBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RouteMirroringMessage, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedMirror
.Construct a new builder initialized from specifiedPeerHeader
.Construct a builder initialized with state from specifiedRouteMirroringMessage
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull RouteMirroringMessage
build()
A newRouteMirroringMessage
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.getTlvs()
Return current value associated with the property corresponding toMirror.getTlvs()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteMirroringMessage>> augmentationType) Remove an augmentation from this builder's product.setPeerHeader
(PeerHeader value) Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.Set the property corresponding toMirror.getTlvs()
to the specified value.
-
Constructor Details
-
RouteMirroringMessageBuilder
public RouteMirroringMessageBuilder()Construct an empty builder. -
RouteMirroringMessageBuilder
Construct a new builder initialized from specifiedPeerHeader
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.PeerHeader from which the builder should be initialized
-
RouteMirroringMessageBuilder
Construct a new builder initialized from specifiedMirror
.- Parameters:
arg
- Mirror from which the builder should be initialized
-
RouteMirroringMessageBuilder
Construct a builder initialized with state from specifiedRouteMirroringMessage
.- Parameters:
base
- RouteMirroringMessage from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getPeerHeader
Return current value associated with the property corresponding toPeerHeader.getPeerHeader()
.- Returns:
- current value
-
getTlvs
Return current value associated with the property corresponding toMirror.getTlvs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteMirroringMessage>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setPeerHeader
Set the property corresponding toPeerHeader.getPeerHeader()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTlvs
Set the property corresponding toMirror.getTlvs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
A newRouteMirroringMessage
instance.- Returns:
- A new
RouteMirroringMessage
instance.
-