Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.gc.object
Class GcBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.gc.object.GcBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Gc>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Gc,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class GcBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Gc>
Class that buildsGcBuilder
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:
GcBuilder createTarget(int fooXyzzy, int barBaz) { return new GcBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of GcBuilder, 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:
GcBuilder
,Builder
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GcBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Gc> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>>
E$$augmentation(Class<E$$> augmentationType)
Gc
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getMaxHop()
org.opendaylight.yangtools.yang.common.Uint8
getMaxUtilization()
org.opendaylight.yangtools.yang.common.Uint8
getMinUtilization()
org.opendaylight.yangtools.yang.common.Uint8
getOverBookingFactor()
Tlvs
getTlvs()
Boolean
isIgnore()
Boolean
isProcessingRule()
GcBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> augmentationType)
GcBuilder
setIgnore(Boolean value)
GcBuilder
setMaxHop(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxHop(Uint8)} instead.GcBuilder
setMaxHop(org.opendaylight.yangtools.yang.common.Uint8 value)
GcBuilder
setMaxUtilization(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxUtilization(Uint8)} instead.GcBuilder
setMaxUtilization(org.opendaylight.yangtools.yang.common.Uint8 value)
GcBuilder
setMinUtilization(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMinUtilization(Uint8)} instead.GcBuilder
setMinUtilization(org.opendaylight.yangtools.yang.common.Uint8 value)
GcBuilder
setOverBookingFactor(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOverBookingFactor(Uint8)} instead.GcBuilder
setOverBookingFactor(org.opendaylight.yangtools.yang.common.Uint8 value)
GcBuilder
setProcessingRule(Boolean value)
GcBuilder
setTlvs(Tlvs value)
-
-
-
Constructor Detail
-
GcBuilder
public GcBuilder()
-
GcBuilder
public GcBuilder(Object arg)
-
GcBuilder
public GcBuilder(ObjectHeader arg)
-
GcBuilder
public GcBuilder(Gc 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.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getMaxHop
public org.opendaylight.yangtools.yang.common.Uint8 getMaxHop()
-
getMaxUtilization
public org.opendaylight.yangtools.yang.common.Uint8 getMaxUtilization()
-
getMinUtilization
public org.opendaylight.yangtools.yang.common.Uint8 getMinUtilization()
-
getOverBookingFactor
public org.opendaylight.yangtools.yang.common.Uint8 getOverBookingFactor()
-
getTlvs
public Tlvs getTlvs()
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> E$$ augmentation(Class<E$$> augmentationType)
-
setMaxHop
public GcBuilder setMaxHop(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMaxHop
@Deprecated(forRemoval=true) public GcBuilder setMaxHop(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxHop(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMaxUtilization
public GcBuilder setMaxUtilization(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMaxUtilization
@Deprecated(forRemoval=true) public GcBuilder setMaxUtilization(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxUtilization(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMinUtilization
public GcBuilder setMinUtilization(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMinUtilization
@Deprecated(forRemoval=true) public GcBuilder setMinUtilization(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMinUtilization(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOverBookingFactor
public GcBuilder setOverBookingFactor(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setOverBookingFactor
@Deprecated(forRemoval=true) public GcBuilder setOverBookingFactor(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOverBookingFactor(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public GcBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Gc> augmentationValue)
-
removeAugmentation
public GcBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> augmentationType)
-
build
public Gc build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Gc>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Gc,IllegalArgumentException>
-
-