Class BasicFastRerouteObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.fast.reroute.object.fast.reroute.object.basic.fast.reroute.object._case.BasicFastRerouteObjectBuilder
-
@Generated("mdsal-binding-generator") public class BasicFastRerouteObjectBuilder extends Object
Class that buildsBasicFastRerouteObject
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:
BasicFastRerouteObject createBasicFastRerouteObject(int fooXyzzy, int barBaz) { return new BasicFastRerouteObjectBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BasicFastRerouteObject, 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:
BasicFastRerouteObject
- 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 BasicFastRerouteObjectBuilder()
Construct an empty builder.BasicFastRerouteObjectBuilder(AttributeFilters arg)
Construct a new builder initialized from specifiedAttributeFilters
.BasicFastRerouteObjectBuilder(CommonFastRerouteObject arg)
Construct a new builder initialized from specifiedCommonFastRerouteObject
.BasicFastRerouteObjectBuilder(BasicFastRerouteObject base)
Construct a builder initialized with state from specifiedBasicFastRerouteObject
.BasicFastRerouteObjectBuilder(Priority arg)
Construct a new builder initialized from specifiedPriority
.BasicFastRerouteObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BasicFastRerouteObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BasicFastRerouteObject
build()
A newBasicFastRerouteObject
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Bandwidth
getBandwidth()
Return current value associated with the property corresponding toCommonFastRerouteObject.getBandwidth()
.AttributeFilter
getExcludeAny()
Return current value associated with the property corresponding toAttributeFilters.getExcludeAny()
.FastRerouteFlags
getFlags()
Return current value associated with the property corresponding toCommonFastRerouteObject.getFlags()
.org.opendaylight.yangtools.yang.common.Uint8
getHoldPriority()
Return current value associated with the property corresponding toPriority.getHoldPriority()
.org.opendaylight.yangtools.yang.common.Uint8
getHopLimit()
Return current value associated with the property corresponding toCommonFastRerouteObject.getHopLimit()
.AttributeFilter
getIncludeAll()
Return current value associated with the property corresponding toAttributeFilters.getIncludeAll()
.AttributeFilter
getIncludeAny()
Return current value associated with the property corresponding toAttributeFilters.getIncludeAny()
.org.opendaylight.yangtools.yang.common.Uint8
getSetupPriority()
Return current value associated with the property corresponding toPriority.getSetupPriority()
.BasicFastRerouteObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>> augmentationType)
Remove an augmentation from this builder's product.BasicFastRerouteObjectBuilder
setBandwidth(Bandwidth value)
Set the property corresponding toCommonFastRerouteObject.getBandwidth()
to the specified value.BasicFastRerouteObjectBuilder
setExcludeAny(AttributeFilter value)
Set the property corresponding toAttributeFilters.getExcludeAny()
to the specified value.BasicFastRerouteObjectBuilder
setFlags(FastRerouteFlags value)
Set the property corresponding toCommonFastRerouteObject.getFlags()
to the specified value.BasicFastRerouteObjectBuilder
setHoldPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toPriority.getHoldPriority()
to the specified value.BasicFastRerouteObjectBuilder
setHopLimit(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toCommonFastRerouteObject.getHopLimit()
to the specified value.BasicFastRerouteObjectBuilder
setIncludeAll(AttributeFilter value)
Set the property corresponding toAttributeFilters.getIncludeAll()
to the specified value.BasicFastRerouteObjectBuilder
setIncludeAny(AttributeFilter value)
Set the property corresponding toAttributeFilters.getIncludeAny()
to the specified value.BasicFastRerouteObjectBuilder
setSetupPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toPriority.getSetupPriority()
to the specified value.
-
-
-
Constructor Detail
-
BasicFastRerouteObjectBuilder
public BasicFastRerouteObjectBuilder()
Construct an empty builder.
-
BasicFastRerouteObjectBuilder
public BasicFastRerouteObjectBuilder(CommonFastRerouteObject arg)
Construct a new builder initialized from specifiedCommonFastRerouteObject
.- Parameters:
arg
- CommonFastRerouteObject from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
public BasicFastRerouteObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.- Parameters:
arg
- RsvpTeObject from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
public BasicFastRerouteObjectBuilder(Priority arg)
Construct a new builder initialized from specifiedPriority
.- Parameters:
arg
- Priority from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
public BasicFastRerouteObjectBuilder(AttributeFilters arg)
Construct a new builder initialized from specifiedAttributeFilters
.- Parameters:
arg
- AttributeFilters from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
public BasicFastRerouteObjectBuilder(BasicFastRerouteObject base)
Construct a builder initialized with state from specifiedBasicFastRerouteObject
.- Parameters:
base
- BasicFastRerouteObject 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
-
getBandwidth
public Bandwidth getBandwidth()
Return current value associated with the property corresponding toCommonFastRerouteObject.getBandwidth()
.- Returns:
- current value
-
getExcludeAny
public AttributeFilter getExcludeAny()
Return current value associated with the property corresponding toAttributeFilters.getExcludeAny()
.- Returns:
- current value
-
getFlags
public FastRerouteFlags getFlags()
Return current value associated with the property corresponding toCommonFastRerouteObject.getFlags()
.- Returns:
- current value
-
getHoldPriority
public org.opendaylight.yangtools.yang.common.Uint8 getHoldPriority()
Return current value associated with the property corresponding toPriority.getHoldPriority()
.- Returns:
- current value
-
getHopLimit
public org.opendaylight.yangtools.yang.common.Uint8 getHopLimit()
Return current value associated with the property corresponding toCommonFastRerouteObject.getHopLimit()
.- Returns:
- current value
-
getIncludeAll
public AttributeFilter getIncludeAll()
Return current value associated with the property corresponding toAttributeFilters.getIncludeAll()
.- Returns:
- current value
-
getIncludeAny
public AttributeFilter getIncludeAny()
Return current value associated with the property corresponding toAttributeFilters.getIncludeAny()
.- Returns:
- current value
-
getSetupPriority
public org.opendaylight.yangtools.yang.common.Uint8 getSetupPriority()
Return current value associated with the property corresponding toPriority.getSetupPriority()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>> 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
-
setBandwidth
public BasicFastRerouteObjectBuilder setBandwidth(Bandwidth value)
Set the property corresponding toCommonFastRerouteObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExcludeAny
public BasicFastRerouteObjectBuilder setExcludeAny(AttributeFilter value)
Set the property corresponding toAttributeFilters.getExcludeAny()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public BasicFastRerouteObjectBuilder setFlags(FastRerouteFlags value)
Set the property corresponding toCommonFastRerouteObject.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHoldPriority
public BasicFastRerouteObjectBuilder setHoldPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toPriority.getHoldPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHopLimit
public BasicFastRerouteObjectBuilder setHopLimit(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toCommonFastRerouteObject.getHopLimit()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIncludeAll
public BasicFastRerouteObjectBuilder setIncludeAll(AttributeFilter value)
Set the property corresponding toAttributeFilters.getIncludeAll()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIncludeAny
public BasicFastRerouteObjectBuilder setIncludeAny(AttributeFilter value)
Set the property corresponding toAttributeFilters.getIncludeAny()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSetupPriority
public BasicFastRerouteObjectBuilder setSetupPriority(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toPriority.getSetupPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BasicFastRerouteObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject> 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 BasicFastRerouteObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>> 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 BasicFastRerouteObject build()
A newBasicFastRerouteObject
instance.- Returns:
- A new
BasicFastRerouteObject
instance.
-
-