Class BoundServicesStateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.servicebinding.rev160406.bound.services.state.list.BoundServicesStateBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BoundServicesState>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BoundServicesState,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BoundServicesStateBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BoundServicesState>
Class that buildsBoundServicesStateBuilder
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:
BoundServicesStateBuilder createTarget(int fooXyzzy, int barBaz) { return new BoundServicesStateBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BoundServicesStateBuilder, 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:
BoundServicesStateBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BoundServicesStateBuilder()
BoundServicesStateBuilder(BoundServicesState base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BoundServicesStateBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BoundServicesState> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServicesState>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BoundServicesState
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpid()
java.lang.Integer
getIfIndex()
java.lang.String
getInterfaceName()
java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType>
getInterfaceType()
org.opendaylight.yangtools.yang.common.Uint32
getPortNo()
java.lang.Class<? extends ServiceModeBase>
getServiceMode()
BoundServicesStateKey
key()
BoundServicesStateBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServicesState>> augmentationType)
Remove an augmentation from this builder's product.BoundServicesStateBuilder
setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.BoundServicesStateBuilder
setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
BoundServicesStateBuilder
setIfIndex(java.lang.Integer value)
BoundServicesStateBuilder
setInterfaceName(java.lang.String value)
BoundServicesStateBuilder
setInterfaceType(java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> value)
BoundServicesStateBuilder
setPortNo(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPortNo(Uint32)
instead.BoundServicesStateBuilder
setPortNo(org.opendaylight.yangtools.yang.common.Uint32 value)
BoundServicesStateBuilder
setServiceMode(java.lang.Class<? extends ServiceModeBase> value)
BoundServicesStateBuilder
withKey(BoundServicesStateKey key)
-
-
-
Constructor Detail
-
BoundServicesStateBuilder
public BoundServicesStateBuilder()
-
BoundServicesStateBuilder
public BoundServicesStateBuilder(BoundServicesState base)
-
-
Method Detail
-
key
public BoundServicesStateKey key()
-
getDpid
public org.opendaylight.yangtools.yang.common.Uint64 getDpid()
-
getIfIndex
public java.lang.Integer getIfIndex()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
getInterfaceType
public java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> getInterfaceType()
-
getPortNo
public org.opendaylight.yangtools.yang.common.Uint32 getPortNo()
-
getServiceMode
public java.lang.Class<? extends ServiceModeBase> getServiceMode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServicesState>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public BoundServicesStateBuilder withKey(BoundServicesStateKey key)
-
setDpid
public BoundServicesStateBuilder setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpid
@Deprecated(forRemoval=true) public BoundServicesStateBuilder setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIfIndex
public BoundServicesStateBuilder setIfIndex(java.lang.Integer value)
-
setInterfaceName
public BoundServicesStateBuilder setInterfaceName(java.lang.String value)
-
setInterfaceType
public BoundServicesStateBuilder setInterfaceType(java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> value)
-
setPortNo
public BoundServicesStateBuilder setPortNo(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPortNo
@Deprecated(forRemoval=true) public BoundServicesStateBuilder setPortNo(java.lang.Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPortNo(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setServiceMode
public BoundServicesStateBuilder setServiceMode(java.lang.Class<? extends ServiceModeBase> value)
-
addAugmentation
public BoundServicesStateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BoundServicesState> 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 BoundServicesStateBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BoundServicesState>> 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 BoundServicesState build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BoundServicesState>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BoundServicesState,java.lang.IllegalArgumentException>
-
-