Class TryLockInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.lockmanager.rev160413.TryLockInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TryLockInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TryLockInput,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TryLockInputBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TryLockInput>
Class that buildsTryLockInputBuilder
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:
TryLockInputBuilder createTarget(int fooXyzzy, int barBaz) { return new TryLockInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TryLockInputBuilder, 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:
TryLockInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TryLockInputBuilder()
TryLockInputBuilder(TryLockInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TryLockInputBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TryLockInput
build()
java.lang.String
getLockName()
org.opendaylight.yangtools.yang.common.Uint32
getTime()
TimeUnits
getTimeUnit()
TryLockInputBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput>> augmentationType)
TryLockInputBuilder
setLockName(java.lang.String value)
TryLockInputBuilder
setTime(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTime(Uint32)} instead.TryLockInputBuilder
setTime(org.opendaylight.yangtools.yang.common.Uint32 value)
TryLockInputBuilder
setTimeUnit(TimeUnits value)
-
-
-
Constructor Detail
-
TryLockInputBuilder
public TryLockInputBuilder()
-
TryLockInputBuilder
public TryLockInputBuilder(TryLockInput base)
-
-
Method Detail
-
getLockName
public java.lang.String getLockName()
-
getTime
public org.opendaylight.yangtools.yang.common.Uint32 getTime()
-
getTimeUnit
public TimeUnits getTimeUnit()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setLockName
public TryLockInputBuilder setLockName(java.lang.String value)
-
setTime
public TryLockInputBuilder setTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setTime
@Deprecated(forRemoval=true) public TryLockInputBuilder setTime(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTime(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTimeUnit
public TryLockInputBuilder setTimeUnit(TimeUnits value)
-
addAugmentation
public TryLockInputBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput> augmentationValue)
-
removeAugmentation
public TryLockInputBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TryLockInput>> augmentationType)
-
build
public TryLockInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TryLockInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TryLockInput,java.lang.IllegalArgumentException>
-
-