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