Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info
Class TunnelEndPointsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.dpn.endpoints.dpn.teps.info.TunnelEndPointsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunnelEndPoints>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunnelEndPoints,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TunnelEndPointsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TunnelEndPoints>
Class that buildsTunnelEndPointsBuilder
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:
TunnelEndPointsBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelEndPointsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelEndPointsBuilder, 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:
TunnelEndPointsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelEndPointsBuilder()
TunnelEndPointsBuilder(TunnelEndPoints base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TunnelEndPointsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelEndPoints> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelEndPoints>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TunnelEndPoints
build()
java.lang.String
getInterfaceName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getIpAddress()
java.lang.Boolean
getOptionOfTunnel()
java.lang.String
getOptionTunnelTos()
java.lang.Class<? extends TunnelTypeBase>
getTunnelType()
java.util.Map<TzMembershipKey,TzMembership>
getTzMembership()
java.lang.Boolean
isOptionOfTunnel()
Deprecated, for removal: This API element is subject to removal in a future version.TunnelEndPointsKey
key()
TunnelEndPointsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelEndPoints>> augmentationType)
Remove an augmentation from this builder's product.TunnelEndPointsBuilder
setInterfaceName(java.lang.String value)
TunnelEndPointsBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
TunnelEndPointsBuilder
setOptionOfTunnel(java.lang.Boolean value)
TunnelEndPointsBuilder
setOptionTunnelTos(java.lang.String value)
TunnelEndPointsBuilder
setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
TunnelEndPointsBuilder
setTzMembership(java.util.List<TzMembership> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTzMembership(Map)
instead.TunnelEndPointsBuilder
setTzMembership(java.util.Map<TzMembershipKey,TzMembership> values)
TunnelEndPointsBuilder
withKey(TunnelEndPointsKey key)
-
-
-
Constructor Detail
-
TunnelEndPointsBuilder
public TunnelEndPointsBuilder()
-
TunnelEndPointsBuilder
public TunnelEndPointsBuilder(TunnelEndPoints base)
-
-
Method Detail
-
key
public TunnelEndPointsKey key()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
-
getOptionOfTunnel
public java.lang.Boolean getOptionOfTunnel()
-
isOptionOfTunnel
@Deprecated(forRemoval=true) public final java.lang.Boolean isOptionOfTunnel()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getOptionTunnelTos
public java.lang.String getOptionTunnelTos()
-
getTunnelType
public java.lang.Class<? extends TunnelTypeBase> getTunnelType()
-
getTzMembership
public java.util.Map<TzMembershipKey,TzMembership> getTzMembership()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelEndPoints>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public TunnelEndPointsBuilder withKey(TunnelEndPointsKey key)
-
setInterfaceName
public TunnelEndPointsBuilder setInterfaceName(java.lang.String value)
-
setIpAddress
public TunnelEndPointsBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setOptionOfTunnel
public TunnelEndPointsBuilder setOptionOfTunnel(java.lang.Boolean value)
-
setOptionTunnelTos
public TunnelEndPointsBuilder setOptionTunnelTos(java.lang.String value)
-
setTunnelType
public TunnelEndPointsBuilder setTunnelType(java.lang.Class<? extends TunnelTypeBase> value)
-
setTzMembership
public TunnelEndPointsBuilder setTzMembership(java.util.Map<TzMembershipKey,TzMembership> values)
-
setTzMembership
@Deprecated(forRemoval=true) public TunnelEndPointsBuilder setTzMembership(java.util.List<TzMembership> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTzMembership(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
addAugmentation
public TunnelEndPointsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelEndPoints> 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 TunnelEndPointsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelEndPoints>> 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 TunnelEndPoints build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunnelEndPoints>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunnelEndPoints,java.lang.IllegalArgumentException>
-
-