org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result

Class FailureCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.FailureCaseBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<FailureCase>, org.opendaylight.yangtools.concepts.CheckedBuilder<FailureCase,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class FailureCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FailureCase>

Class that builds FailureCaseBuilder 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:

   
     FailureCaseBuilder createTarget(int fooXyzzy, int barBaz) {
         return new FailureCaseBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of FailureCaseBuilder, 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:

FailureCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FailureCaseBuilder()
FailureCaseBuilder(BandwidthObject arg)
FailureCaseBuilder(ClasstypeObject arg)
FailureCaseBuilder(ExcludeRouteObject arg)
FailureCaseBuilder(FailureCase base)
FailureCaseBuilder(IncludeRouteObject arg)
FailureCaseBuilder(LspaObject arg)
FailureCaseBuilder(LspAttributes arg)
FailureCaseBuilder(OfObject arg)
FailureCaseBuilder(ReoptimizationBandwidthObject arg)
FailureCaseBuilder(ReportedRouteObject arg)

Method Summary

Modifier and Type	Method and Description
FailureCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> E$$	augmentation(Class<E$$> augmentationType)
FailureCase	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Bandwidth	getBandwidth()
ClassType	getClassType()
Iro	getIro()
Lspa	getLspa()
List<Metrics>	getMetrics()
NoPath	getNoPath()
Of	getOf()
ReoptimizationBandwidth	getReoptimizationBandwidth()
Rro	getRro()
Xro	getXro()
FailureCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType)
FailureCaseBuilder	setBandwidth(Bandwidth value)
FailureCaseBuilder	setClassType(ClassType value)
FailureCaseBuilder	setIro(Iro value)
FailureCaseBuilder	setLspa(Lspa value)
FailureCaseBuilder	setMetrics(List<Metrics> values)
FailureCaseBuilder	setNoPath(NoPath value)
FailureCaseBuilder	setOf(Of value)
FailureCaseBuilder	setReoptimizationBandwidth(ReoptimizationBandwidth value)
FailureCaseBuilder	setRro(Rro value)
FailureCaseBuilder	setXro(Xro value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FailureCaseBuilder

public FailureCaseBuilder()

FailureCaseBuilder

public FailureCaseBuilder(LspAttributes arg)

FailureCaseBuilder

public FailureCaseBuilder(IncludeRouteObject arg)

FailureCaseBuilder

public FailureCaseBuilder(ReportedRouteObject arg)

FailureCaseBuilder

public FailureCaseBuilder(ClasstypeObject arg)

FailureCaseBuilder

public FailureCaseBuilder(LspaObject arg)

FailureCaseBuilder

public FailureCaseBuilder(ExcludeRouteObject arg)

FailureCaseBuilder

public FailureCaseBuilder(BandwidthObject arg)

FailureCaseBuilder

public FailureCaseBuilder(OfObject arg)

FailureCaseBuilder

public FailureCaseBuilder(ReoptimizationBandwidthObject arg)

FailureCaseBuilder

public FailureCaseBuilder(FailureCase base)

Method Detail

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:

• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ClasstypeObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ReoptimizationBandwidthObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.BandwidthObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.OfObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ReportedRouteObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.LspAttributes
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.IncludeRouteObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ExcludeRouteObject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.LspaObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getBandwidth

public Bandwidth getBandwidth()

getClassType

public ClassType getClassType()

getIro

public Iro getIro()

getLspa

public Lspa getLspa()

getMetrics

public List<Metrics> getMetrics()

getNoPath

public NoPath getNoPath()

getOf

public Of getOf()

getReoptimizationBandwidth

public ReoptimizationBandwidth getReoptimizationBandwidth()

getRro

public Rro getRro()

getXro

public Xro getXro()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> E$$ augmentation(Class<E$$> augmentationType)

setBandwidth

public FailureCaseBuilder setBandwidth(Bandwidth value)

setClassType

public FailureCaseBuilder setClassType(ClassType value)

setIro

public FailureCaseBuilder setIro(Iro value)

setLspa

public FailureCaseBuilder setLspa(Lspa value)

setMetrics

public FailureCaseBuilder setMetrics(List<Metrics> values)

setNoPath

public FailureCaseBuilder setNoPath(NoPath value)

setOf

public FailureCaseBuilder setOf(Of value)

setReoptimizationBandwidth

public FailureCaseBuilder setReoptimizationBandwidth(ReoptimizationBandwidth value)

setRro

public FailureCaseBuilder setRro(Rro value)

setXro

public FailureCaseBuilder setXro(Xro value)

addAugmentation

public FailureCaseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType,
                                          org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase> augmentationValue)

removeAugmentation

public FailureCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FailureCase>> augmentationType)

build

public FailureCase build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<FailureCase,IllegalArgumentException>