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
Class that builds
BasicFastRerouteObject
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedAttributeFilters
.Construct a new builder initialized from specifiedCommonFastRerouteObject
.Construct a builder initialized with state from specifiedBasicFastRerouteObject
.Construct a new builder initialized from specifiedPriority
.Construct a new builder initialized from specifiedRsvpTeObject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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.static @NonNull BasicFastRerouteObject
empty()
Get empty instance of BasicFastRerouteObject.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toCommonFastRerouteObject.getBandwidth()
.Return current value associated with the property corresponding toAttributeFilters.getExcludeAny()
.getFlags()
Return current value associated with the property corresponding toCommonFastRerouteObject.getFlags()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toPriority.getHoldPriority()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toCommonFastRerouteObject.getHopLimit()
.Return current value associated with the property corresponding toAttributeFilters.getIncludeAll()
.Return current value associated with the property corresponding toAttributeFilters.getIncludeAny()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toPriority.getSetupPriority()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicFastRerouteObject>> augmentationType) Remove an augmentation from this builder's product.setBandwidth
(Bandwidth value) Set the property corresponding toCommonFastRerouteObject.getBandwidth()
to the specified value.setExcludeAny
(AttributeFilter value) Set the property corresponding toAttributeFilters.getExcludeAny()
to the specified value.setFlags
(FastRerouteFlags value) Set the property corresponding toCommonFastRerouteObject.getFlags()
to the specified value.setHoldPriority
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPriority.getHoldPriority()
to the specified value.setHopLimit
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toCommonFastRerouteObject.getHopLimit()
to the specified value.setIncludeAll
(AttributeFilter value) Set the property corresponding toAttributeFilters.getIncludeAll()
to the specified value.setIncludeAny
(AttributeFilter value) Set the property corresponding toAttributeFilters.getIncludeAny()
to the specified value.setSetupPriority
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toPriority.getSetupPriority()
to the specified value.
-
Constructor Details
-
BasicFastRerouteObjectBuilder
public BasicFastRerouteObjectBuilder()Construct an empty builder. -
BasicFastRerouteObjectBuilder
Construct a new builder initialized from specifiedCommonFastRerouteObject
.- Parameters:
arg
- CommonFastRerouteObject from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
Construct a new builder initialized from specifiedRsvpTeObject
.- Parameters:
arg
- RsvpTeObject from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
Construct a new builder initialized from specifiedPriority
.- Parameters:
arg
- Priority from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
Construct a new builder initialized from specifiedAttributeFilters
.- Parameters:
arg
- AttributeFilters from which the builder should be initialized
-
BasicFastRerouteObjectBuilder
Construct a builder initialized with state from specifiedBasicFastRerouteObject
.- Parameters:
base
- BasicFastRerouteObject 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
-
empty
Get empty instance of BasicFastRerouteObject.- Returns:
- An empty
BasicFastRerouteObject
-
getBandwidth
Return current value associated with the property corresponding toCommonFastRerouteObject.getBandwidth()
.- Returns:
- current value
-
getExcludeAny
Return current value associated with the property corresponding toAttributeFilters.getExcludeAny()
.- Returns:
- current value
-
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
Return current value associated with the property corresponding toAttributeFilters.getIncludeAll()
.- Returns:
- current value
-
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
Set the property corresponding toCommonFastRerouteObject.getBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExcludeAny
Set the property corresponding toAttributeFilters.getExcludeAny()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
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
Set the property corresponding toAttributeFilters.getIncludeAll()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIncludeAny
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
A newBasicFastRerouteObject
instance.- Returns:
- A new
BasicFastRerouteObject
instance.
-