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>
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
-
-
-
Constructor Detail
-
ProtectionSubobjectBuilder
public ProtectionSubobjectBuilder()
-
ProtectionSubobjectBuilder
public ProtectionSubobjectBuilder(ProtectionSubobject base)
-
-
Method Detail
-
getLinkFlags
public LinkFlags getLinkFlags()
-
getLspFlag
public LspFlag getLspFlag()
-
getSegFlag
public LspFlag getSegFlag()
-
isInPlace
public Boolean isInPlace()
-
isNotification
public Boolean isNotification()
-
isOperational
public Boolean isOperational()
-
isProtecting
public Boolean isProtecting()
-
isRequired
public Boolean isRequired()
-
isSecondary
public Boolean isSecondary()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> E$$ augmentation(Class<E$$> augmentationType)
-
setLinkFlags
public ProtectionSubobjectBuilder setLinkFlags(LinkFlags value)
-
setLspFlag
public ProtectionSubobjectBuilder setLspFlag(LspFlag value)
-
setSegFlag
public ProtectionSubobjectBuilder setSegFlag(LspFlag value)
-
setInPlace
public ProtectionSubobjectBuilder setInPlace(Boolean 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)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public ProtectionSubobjectBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ProtectionSubobject> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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>
-
-