Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.order.tlv
Class OrderBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.order.tlv.OrderBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Order>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Order,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class OrderBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Order>
Class that buildsOrderBuilder
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:
OrderBuilder createTarget(int fooXyzzy, int barBaz) { return new OrderBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OrderBuilder, 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:
OrderBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OrderBuilder()
OrderBuilder(Order base)
OrderBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OrderBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Order>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Order> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Order>>
E$$augmentation(Class<E$$> augmentationType)
Order
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getDelete()
org.opendaylight.yangtools.yang.common.Uint32
getSetup()
OrderBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Order>> augmentationType)
OrderBuilder
setDelete(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDelete(Uint32)} instead.OrderBuilder
setDelete(org.opendaylight.yangtools.yang.common.Uint32 value)
OrderBuilder
setSetup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSetup(Uint32)} instead.OrderBuilder
setSetup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
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.Tlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getDelete
public org.opendaylight.yangtools.yang.common.Uint32 getDelete()
-
getSetup
public org.opendaylight.yangtools.yang.common.Uint32 getSetup()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Order>> E$$ augmentation(Class<E$$> augmentationType)
-
setDelete
public OrderBuilder setDelete(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDelete
@Deprecated(forRemoval=true) public OrderBuilder setDelete(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDelete(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSetup
public OrderBuilder setSetup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSetup
@Deprecated(forRemoval=true) public OrderBuilder setSetup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSetup(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public OrderBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Order>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Order> augmentationValue)
-
removeAugmentation
public OrderBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Order>> augmentationType)
-
build
public Order build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Order>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Order,IllegalArgumentException>
-
-