Class DscpsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.flowspec.destination.flowspec.flowspec.type.dscp._case.DscpsBuilder
-
@Generated("mdsal-binding-generator") public class DscpsBuilder extends Object
Class that buildsDscps
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:
Dscps createDscps(int fooXyzzy, int barBaz) { return new DscpsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Dscps, 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:
Dscps
- 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 DscpsBuilder()
Construct an empty builder.DscpsBuilder(DscpValue arg)
Construct a new builder initialized from specifiedDscpValue
.DscpsBuilder(Dscps base)
Construct a builder initialized with state from specifiedDscps
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DscpsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Dscps> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dscps>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Dscps
build()
A newDscps
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NumericOperand
getOp()
Return current value associated with the property corresponding toDscpValue.getOp()
.Dscp
getValue()
Return current value associated with the property corresponding toDscpValue.getValue()
.DscpsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dscps>> augmentationType)
Remove an augmentation from this builder's product.DscpsBuilder
setOp(NumericOperand value)
Set the property corresponding toDscpValue.getOp()
to the specified value.DscpsBuilder
setValue(Dscp value)
Set the property corresponding toDscpValue.getValue()
to the specified value.
-
-
-
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
-
getOp
public NumericOperand getOp()
Return current value associated with the property corresponding toDscpValue.getOp()
.- Returns:
- current value
-
getValue
public Dscp getValue()
Return current value associated with the property corresponding toDscpValue.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dscps>> 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
-
setOp
public DscpsBuilder setOp(NumericOperand value)
Set the property corresponding toDscpValue.getOp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public DscpsBuilder setValue(Dscp value)
Set the property corresponding toDscpValue.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DscpsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Dscps> 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 DscpsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dscps>> 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
-
-