Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.protection.subobject
Class ProtectionSubobjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.protection.subobject.ProtectionSubobjectBuilder
-
@Generated("mdsal-binding-generator") public class ProtectionSubobjectBuilder extends Object
Class that buildsProtectionSubobject
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:
ProtectionSubobject createProtectionSubobject(int fooXyzzy, int barBaz) { return new ProtectionSubobjectBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProtectionSubobject, 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:
ProtectionSubobject
- 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 ProtectionSubobjectBuilder()
Construct an empty builder.ProtectionSubobjectBuilder(ProtectionSubobject base)
Construct a builder initialized with state from specifiedProtectionSubobject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProtectionSubobjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ProtectionSubobject
build()
A newProtectionSubobject
instance.Boolean
getInPlace()
Return current value associated with the property corresponding toProtectionSubobject.getInPlace()
.LinkFlags
getLinkFlags()
Return current value associated with the property corresponding toProtectionSubobject.getLinkFlags()
.LspFlag
getLspFlag()
Return current value associated with the property corresponding toProtectionSubobject.getLspFlag()
.Boolean
getNotification()
Return current value associated with the property corresponding toProtectionSubobject.getNotification()
.Boolean
getOperational()
Return current value associated with the property corresponding toProtectionSubobject.getOperational()
.Boolean
getProtecting()
Return current value associated with the property corresponding toProtectionSubobject.getProtecting()
.Boolean
getRequired()
Return current value associated with the property corresponding toProtectionSubobject.getRequired()
.Boolean
getSecondary()
Return current value associated with the property corresponding toProtectionSubobject.getSecondary()
.LspFlag
getSegFlag()
Return current value associated with the property corresponding toProtectionSubobject.getSegFlag()
.ProtectionSubobjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> augmentationType)
Remove an augmentation from this builder's product.ProtectionSubobjectBuilder
setInPlace(Boolean value)
Set the property corresponding toProtectionSubobject.getInPlace()
to the specified value.ProtectionSubobjectBuilder
setLinkFlags(LinkFlags value)
Set the property corresponding toProtectionSubobject.getLinkFlags()
to the specified value.ProtectionSubobjectBuilder
setLspFlag(LspFlag value)
Set the property corresponding toProtectionSubobject.getLspFlag()
to the specified value.ProtectionSubobjectBuilder
setNotification(Boolean value)
Set the property corresponding toProtectionSubobject.getNotification()
to the specified value.ProtectionSubobjectBuilder
setOperational(Boolean value)
Set the property corresponding toProtectionSubobject.getOperational()
to the specified value.ProtectionSubobjectBuilder
setProtecting(Boolean value)
Set the property corresponding toProtectionSubobject.getProtecting()
to the specified value.ProtectionSubobjectBuilder
setRequired(Boolean value)
Set the property corresponding toProtectionSubobject.getRequired()
to the specified value.ProtectionSubobjectBuilder
setSecondary(Boolean value)
Set the property corresponding toProtectionSubobject.getSecondary()
to the specified value.ProtectionSubobjectBuilder
setSegFlag(LspFlag value)
Set the property corresponding toProtectionSubobject.getSegFlag()
to the specified value.
-
-
-
Constructor Detail
-
ProtectionSubobjectBuilder
public ProtectionSubobjectBuilder()
Construct an empty builder.
-
ProtectionSubobjectBuilder
public ProtectionSubobjectBuilder(ProtectionSubobject base)
Construct a builder initialized with state from specifiedProtectionSubobject
.- Parameters:
base
- ProtectionSubobject from which the builder should be initialized
-
-
Method Detail
-
getInPlace
public Boolean getInPlace()
Return current value associated with the property corresponding toProtectionSubobject.getInPlace()
.- Returns:
- current value
-
getLinkFlags
public LinkFlags getLinkFlags()
Return current value associated with the property corresponding toProtectionSubobject.getLinkFlags()
.- Returns:
- current value
-
getLspFlag
public LspFlag getLspFlag()
Return current value associated with the property corresponding toProtectionSubobject.getLspFlag()
.- Returns:
- current value
-
getNotification
public Boolean getNotification()
Return current value associated with the property corresponding toProtectionSubobject.getNotification()
.- Returns:
- current value
-
getOperational
public Boolean getOperational()
Return current value associated with the property corresponding toProtectionSubobject.getOperational()
.- Returns:
- current value
-
getProtecting
public Boolean getProtecting()
Return current value associated with the property corresponding toProtectionSubobject.getProtecting()
.- Returns:
- current value
-
getRequired
public Boolean getRequired()
Return current value associated with the property corresponding toProtectionSubobject.getRequired()
.- Returns:
- current value
-
getSecondary
public Boolean getSecondary()
Return current value associated with the property corresponding toProtectionSubobject.getSecondary()
.- Returns:
- current value
-
getSegFlag
public LspFlag getSegFlag()
Return current value associated with the property corresponding toProtectionSubobject.getSegFlag()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> 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
-
setInPlace
public ProtectionSubobjectBuilder setInPlace(Boolean value)
Set the property corresponding toProtectionSubobject.getInPlace()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLinkFlags
public ProtectionSubobjectBuilder setLinkFlags(LinkFlags value)
Set the property corresponding toProtectionSubobject.getLinkFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspFlag
public ProtectionSubobjectBuilder setLspFlag(LspFlag value)
Set the property corresponding toProtectionSubobject.getLspFlag()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNotification
public ProtectionSubobjectBuilder setNotification(Boolean value)
Set the property corresponding toProtectionSubobject.getNotification()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOperational
public ProtectionSubobjectBuilder setOperational(Boolean value)
Set the property corresponding toProtectionSubobject.getOperational()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtecting
public ProtectionSubobjectBuilder setProtecting(Boolean value)
Set the property corresponding toProtectionSubobject.getProtecting()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRequired
public ProtectionSubobjectBuilder setRequired(Boolean value)
Set the property corresponding toProtectionSubobject.getRequired()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSecondary
public ProtectionSubobjectBuilder setSecondary(Boolean value)
Set the property corresponding toProtectionSubobject.getSecondary()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSegFlag
public ProtectionSubobjectBuilder setSegFlag(LspFlag value)
Set the property corresponding toProtectionSubobject.getSegFlag()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ProtectionSubobjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject> 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 ProtectionSubobjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> 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 ProtectionSubobject build()
A newProtectionSubobject
instance.- Returns:
- A new
ProtectionSubobject
instance.
-
-