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
Class that builds
ProtectionSubobject
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedProtectionSubobject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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.static @NonNull ProtectionSubobject
empty()
Get empty instance of ProtectionSubobject.Return current value associated with the property corresponding toProtectionSubobject.getInPlace()
.Return current value associated with the property corresponding toProtectionSubobject.getLinkFlags()
.Return current value associated with the property corresponding toProtectionSubobject.getLspFlag()
.Return current value associated with the property corresponding toProtectionSubobject.getNotification()
.Return current value associated with the property corresponding toProtectionSubobject.getOperational()
.Return current value associated with the property corresponding toProtectionSubobject.getProtecting()
.Return current value associated with the property corresponding toProtectionSubobject.getRequired()
.Return current value associated with the property corresponding toProtectionSubobject.getSecondary()
.Return current value associated with the property corresponding toProtectionSubobject.getSegFlag()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> augmentationType) Remove an augmentation from this builder's product.setInPlace
(Boolean value) Set the property corresponding toProtectionSubobject.getInPlace()
to the specified value.setLinkFlags
(LinkFlags value) Set the property corresponding toProtectionSubobject.getLinkFlags()
to the specified value.setLspFlag
(LspFlag value) Set the property corresponding toProtectionSubobject.getLspFlag()
to the specified value.setNotification
(Boolean value) Set the property corresponding toProtectionSubobject.getNotification()
to the specified value.setOperational
(Boolean value) Set the property corresponding toProtectionSubobject.getOperational()
to the specified value.setProtecting
(Boolean value) Set the property corresponding toProtectionSubobject.getProtecting()
to the specified value.setRequired
(Boolean value) Set the property corresponding toProtectionSubobject.getRequired()
to the specified value.setSecondary
(Boolean value) Set the property corresponding toProtectionSubobject.getSecondary()
to the specified value.setSegFlag
(LspFlag value) Set the property corresponding toProtectionSubobject.getSegFlag()
to the specified value.
-
Constructor Details
-
ProtectionSubobjectBuilder
public ProtectionSubobjectBuilder()Construct an empty builder. -
ProtectionSubobjectBuilder
Construct a builder initialized with state from specifiedProtectionSubobject
.- Parameters:
base
- ProtectionSubobject from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of ProtectionSubobject.- Returns:
- An empty
ProtectionSubobject
-
getInPlace
Return current value associated with the property corresponding toProtectionSubobject.getInPlace()
.- Returns:
- current value
-
getLinkFlags
Return current value associated with the property corresponding toProtectionSubobject.getLinkFlags()
.- Returns:
- current value
-
getLspFlag
Return current value associated with the property corresponding toProtectionSubobject.getLspFlag()
.- Returns:
- current value
-
getNotification
Return current value associated with the property corresponding toProtectionSubobject.getNotification()
.- Returns:
- current value
-
getOperational
Return current value associated with the property corresponding toProtectionSubobject.getOperational()
.- Returns:
- current value
-
getProtecting
Return current value associated with the property corresponding toProtectionSubobject.getProtecting()
.- Returns:
- current value
-
getRequired
Return current value associated with the property corresponding toProtectionSubobject.getRequired()
.- Returns:
- current value
-
getSecondary
Return current value associated with the property corresponding toProtectionSubobject.getSecondary()
.- Returns:
- current value
-
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
Set the property corresponding toProtectionSubobject.getInPlace()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLinkFlags
Set the property corresponding toProtectionSubobject.getLinkFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLspFlag
Set the property corresponding toProtectionSubobject.getLspFlag()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNotification
Set the property corresponding toProtectionSubobject.getNotification()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOperational
Set the property corresponding toProtectionSubobject.getOperational()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtecting
Set the property corresponding toProtectionSubobject.getProtecting()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRequired
Set the property corresponding toProtectionSubobject.getRequired()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSecondary
Set the property corresponding toProtectionSubobject.getSecondary()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSegFlag
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
A newProtectionSubobject
instance.- Returns:
- A new
ProtectionSubobject
instance.
-