Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.flow.spec.object
Class FlowSpecObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.flow.spec.object.FlowSpecObjectBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowSpecObject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowSpecObject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowSpecObjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowSpecObject>
Class that buildsFlowSpecObjectBuilder
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:
FlowSpecObjectBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowSpecObjectBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowSpecObjectBuilder, 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:
FlowSpecObjectBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowSpecObjectBuilder()
FlowSpecObjectBuilder(FlowSpecObject base)
FlowSpecObjectBuilder(RsvpTeObject arg)
FlowSpecObjectBuilder(TspecObject arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowSpecObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>>
E$$augmentation(Class<E$$> augmentationType)
FlowSpecObject
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Float32
getRate()
ServiceNumber
getServiceHeader()
org.opendaylight.yangtools.yang.common.Uint32
getSlackTerm()
TspecObject
getTspecObject()
FlowSpecObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>> augmentationType)
Remove an augmentation from this builder's product.FlowSpecObjectBuilder
setRate(Float32 value)
FlowSpecObjectBuilder
setServiceHeader(ServiceNumber value)
FlowSpecObjectBuilder
setSlackTerm(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSlackTerm(Uint32)
instead.FlowSpecObjectBuilder
setSlackTerm(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowSpecObjectBuilder
setTspecObject(TspecObject value)
-
-
-
Constructor Detail
-
FlowSpecObjectBuilder
public FlowSpecObjectBuilder()
-
FlowSpecObjectBuilder
public FlowSpecObjectBuilder(RsvpTeObject arg)
-
FlowSpecObjectBuilder
public FlowSpecObjectBuilder(TspecObject arg)
-
FlowSpecObjectBuilder
public FlowSpecObjectBuilder(FlowSpecObject 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.rsvp.rev150820.TspecObject
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.RsvpTeObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getRate
public Float32 getRate()
-
getServiceHeader
public ServiceNumber getServiceHeader()
-
getSlackTerm
public org.opendaylight.yangtools.yang.common.Uint32 getSlackTerm()
-
getTspecObject
public TspecObject getTspecObject()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>> E$$ augmentation(Class<E$$> augmentationType)
-
setRate
public FlowSpecObjectBuilder setRate(Float32 value)
-
setServiceHeader
public FlowSpecObjectBuilder setServiceHeader(ServiceNumber value)
-
setSlackTerm
public FlowSpecObjectBuilder setSlackTerm(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSlackTerm
@Deprecated(forRemoval=true) public FlowSpecObjectBuilder setSlackTerm(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSlackTerm(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTspecObject
public FlowSpecObjectBuilder setTspecObject(TspecObject value)
-
addAugmentation
public FlowSpecObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject> 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 FlowSpecObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>> 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 FlowSpecObject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowSpecObject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowSpecObject,IllegalArgumentException>
-
-