Class MonitoringBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.object.MonitoringBuilder
-
@Generated("mdsal-binding-generator") public class MonitoringBuilder extends Object
Class that buildsMonitoring
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:
Monitoring createMonitoring(int fooXyzzy, int barBaz) { return new MonitoringBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Monitoring, 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:
Monitoring
- 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
-
-
Constructor Summary
Constructors Constructor Description MonitoringBuilder()
Construct an empty builder.MonitoringBuilder(Monitoring base)
Construct a builder initialized with state from specifiedMonitoring
.MonitoringBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.MonitoringBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MonitoringBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Monitoring
build()
A newMonitoring
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Monitoring.Flags
getFlags()
Return current value associated with the property corresponding toMonitoring.getFlags()
.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.org.opendaylight.yangtools.yang.common.Uint32
getMonitoringId()
Return current value associated with the property corresponding toMonitoring.getMonitoringId()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Tlvs
getTlvs()
Return current value associated with the property corresponding toMonitoring.getTlvs()
.MonitoringBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring>> augmentationType)
Remove an augmentation from this builder's product.MonitoringBuilder
setFlags(Monitoring.Flags value)
Set the property corresponding toMonitoring.getFlags()
to the specified value.MonitoringBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.MonitoringBuilder
setMonitoringId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMonitoring.getMonitoringId()
to the specified value.MonitoringBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.MonitoringBuilder
setTlvs(Tlvs value)
Set the property corresponding toMonitoring.getTlvs()
to the specified value.
-
-
-
Constructor Detail
-
MonitoringBuilder
public MonitoringBuilder()
Construct an empty builder.
-
MonitoringBuilder
public MonitoringBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
MonitoringBuilder
public MonitoringBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
MonitoringBuilder
public MonitoringBuilder(Monitoring base)
Construct a builder initialized with state from specifiedMonitoring
.- Parameters:
base
- Monitoring from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getFlags
public Monitoring.Flags getFlags()
Return current value associated with the property corresponding toMonitoring.getFlags()
.- Returns:
- current value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getMonitoringId
public org.opendaylight.yangtools.yang.common.Uint32 getMonitoringId()
Return current value associated with the property corresponding toMonitoring.getMonitoringId()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getTlvs
public Tlvs getTlvs()
Return current value associated with the property corresponding toMonitoring.getTlvs()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring>> 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
-
setFlags
public MonitoringBuilder setFlags(Monitoring.Flags value)
Set the property corresponding toMonitoring.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
public MonitoringBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMonitoringId
public MonitoringBuilder setMonitoringId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMonitoring.getMonitoringId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public MonitoringBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTlvs
public MonitoringBuilder setTlvs(Tlvs value)
Set the property corresponding toMonitoring.getTlvs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MonitoringBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring> 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 MonitoringBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Monitoring>> 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 @NonNull Monitoring build()
A newMonitoring
instance.- Returns:
- A new
Monitoring
instance.
-
-