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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ProtectionSubobject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ProtectionSubobject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ProtectionSubobjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ProtectionSubobject>
Class that buildsProtectionSubobjectBuilder
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:
ProtectionSubobjectBuilder createTarget(int fooXyzzy, int barBaz) { return new ProtectionSubobjectBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProtectionSubobjectBuilder, 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:
ProtectionSubobjectBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ProtectionSubobjectBuilder()
ProtectionSubobjectBuilder(ProtectionSubobject base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
ProtectionSubobject
build()
Boolean
getInPlace()
LinkFlags
getLinkFlags()
LspFlag
getLspFlag()
Boolean
getNotification()
Boolean
getOperational()
Boolean
getProtecting()
Boolean
getRequired()
Boolean
getSecondary()
LspFlag
getSegFlag()
Boolean
isInPlace()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isNotification()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isOperational()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isProtecting()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isRequired()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isSecondary()
Deprecated, for removal: This API element is subject to removal in a future version.ProtectionSubobjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> augmentationType)
Remove an augmentation from this builder's product.ProtectionSubobjectBuilder
setInPlace(Boolean value)
ProtectionSubobjectBuilder
setLinkFlags(LinkFlags value)
ProtectionSubobjectBuilder
setLspFlag(LspFlag value)
ProtectionSubobjectBuilder
setNotification(Boolean value)
ProtectionSubobjectBuilder
setOperational(Boolean value)
ProtectionSubobjectBuilder
setProtecting(Boolean value)
ProtectionSubobjectBuilder
setRequired(Boolean value)
ProtectionSubobjectBuilder
setSecondary(Boolean value)
ProtectionSubobjectBuilder
setSegFlag(LspFlag value)
-
-
-
Constructor Detail
-
ProtectionSubobjectBuilder
public ProtectionSubobjectBuilder()
-
ProtectionSubobjectBuilder
public ProtectionSubobjectBuilder(ProtectionSubobject base)
-
-
Method Detail
-
getInPlace
public Boolean getInPlace()
-
isInPlace
@Deprecated(forRemoval=true) public final Boolean isInPlace()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getLinkFlags
public LinkFlags getLinkFlags()
-
getLspFlag
public LspFlag getLspFlag()
-
getNotification
public Boolean getNotification()
-
isNotification
@Deprecated(forRemoval=true) public final Boolean isNotification()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getOperational
public Boolean getOperational()
-
isOperational
@Deprecated(forRemoval=true) public final Boolean isOperational()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getProtecting
public Boolean getProtecting()
-
isProtecting
@Deprecated(forRemoval=true) public final Boolean isProtecting()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getRequired
public Boolean getRequired()
-
isRequired
@Deprecated(forRemoval=true) public final Boolean isRequired()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSecondary
public Boolean getSecondary()
-
isSecondary
@Deprecated(forRemoval=true) public final Boolean isSecondary()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getSegFlag
public LspFlag getSegFlag()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> E$$ augmentation(Class<E$$> augmentationType)
-
setInPlace
public ProtectionSubobjectBuilder setInPlace(Boolean value)
-
setLinkFlags
public ProtectionSubobjectBuilder setLinkFlags(LinkFlags value)
-
setLspFlag
public ProtectionSubobjectBuilder setLspFlag(LspFlag value)
-
setNotification
public ProtectionSubobjectBuilder setNotification(Boolean value)
-
setOperational
public ProtectionSubobjectBuilder setOperational(Boolean value)
-
setProtecting
public ProtectionSubobjectBuilder setProtecting(Boolean value)
-
setRequired
public ProtectionSubobjectBuilder setRequired(Boolean value)
-
setSecondary
public ProtectionSubobjectBuilder setSecondary(Boolean value)
-
setSegFlag
public ProtectionSubobjectBuilder setSegFlag(LspFlag value)
-
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 ProtectionSubobject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ProtectionSubobject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ProtectionSubobject,IllegalArgumentException>
-
-