Class BoundServicesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.service.bindings.services.info.BoundServicesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BoundServices>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BoundServices,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BoundServicesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BoundServices>
Class that buildsBoundServicesBuilder
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:
BoundServicesBuilder createTarget(int fooXyzzy, int barBaz) { return new BoundServicesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BoundServicesBuilder, 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:
BoundServicesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BoundServicesBuilder()
BoundServicesBuilder(BoundServices base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BoundServicesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BoundServices> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServices>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BoundServices
build()
java.lang.String
getServiceName()
org.opendaylight.yangtools.yang.common.Uint8
getServicePriority()
java.lang.Class<? extends ServiceTypeBase>
getServiceType()
BoundServicesKey
key()
BoundServicesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServices>> augmentationType)
Remove an augmentation from this builder's product.BoundServicesBuilder
setServiceName(java.lang.String value)
BoundServicesBuilder
setServicePriority(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetServicePriority(Uint8)
instead.BoundServicesBuilder
setServicePriority(org.opendaylight.yangtools.yang.common.Uint8 value)
BoundServicesBuilder
setServiceType(java.lang.Class<? extends ServiceTypeBase> value)
BoundServicesBuilder
withKey(BoundServicesKey key)
-
-
-
Constructor Detail
-
BoundServicesBuilder
public BoundServicesBuilder()
-
BoundServicesBuilder
public BoundServicesBuilder(BoundServices base)
-
-
Method Detail
-
key
public BoundServicesKey key()
-
getServiceName
public java.lang.String getServiceName()
-
getServicePriority
public org.opendaylight.yangtools.yang.common.Uint8 getServicePriority()
-
getServiceType
public java.lang.Class<? extends ServiceTypeBase> getServiceType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServices>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public BoundServicesBuilder withKey(BoundServicesKey key)
-
setServiceName
public BoundServicesBuilder setServiceName(java.lang.String value)
-
setServicePriority
public BoundServicesBuilder setServicePriority(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setServicePriority
@Deprecated(forRemoval=true) public BoundServicesBuilder setServicePriority(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetServicePriority(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setServiceType
public BoundServicesBuilder setServiceType(java.lang.Class<? extends ServiceTypeBase> value)
-
addAugmentation
public BoundServicesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BoundServices> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public BoundServicesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServices>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public BoundServices build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BoundServices>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BoundServices,java.lang.IllegalArgumentException>
-
-