Class PacketSwitchCapableBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.srlg.attributes._interface.switching.capabilities.PacketSwitchCapableBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PacketSwitchCapable>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PacketSwitchCapable,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PacketSwitchCapableBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketSwitchCapable>
Class that buildsPacketSwitchCapableBuilder
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:
PacketSwitchCapableBuilder createTarget(int fooXyzzy, int barBaz) { return new PacketSwitchCapableBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketSwitchCapableBuilder, 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:
PacketSwitchCapableBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketSwitchCapableBuilder()
PacketSwitchCapableBuilder(PacketSwitchCapable base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PacketSwitchCapableBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable>>
E$$augmentation(Class<E$$> augmentationType)
PacketSwitchCapable
build()
org.opendaylight.yangtools.yang.common.Uint16
getInterfaceMtu()
BigDecimal
getMinimumLspBandwidth()
PacketSwitchCapableBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable>> augmentationType)
Remove an augmentation from this builder's product.PacketSwitchCapableBuilder
setInterfaceMtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceMtu(Uint16)
instead.PacketSwitchCapableBuilder
setInterfaceMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
PacketSwitchCapableBuilder
setMinimumLspBandwidth(BigDecimal value)
-
-
-
Constructor Detail
-
PacketSwitchCapableBuilder
public PacketSwitchCapableBuilder()
-
PacketSwitchCapableBuilder
public PacketSwitchCapableBuilder(PacketSwitchCapable base)
-
-
Method Detail
-
getInterfaceMtu
public org.opendaylight.yangtools.yang.common.Uint16 getInterfaceMtu()
-
getMinimumLspBandwidth
public BigDecimal getMinimumLspBandwidth()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable>> E$$ augmentation(Class<E$$> augmentationType)
-
setInterfaceMtu
public PacketSwitchCapableBuilder setInterfaceMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInterfaceMtu
@Deprecated(forRemoval=true) public PacketSwitchCapableBuilder setInterfaceMtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetInterfaceMtu(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMinimumLspBandwidth
public PacketSwitchCapableBuilder setMinimumLspBandwidth(BigDecimal value)
-
addAugmentation
public PacketSwitchCapableBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public PacketSwitchCapableBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable>> 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 PacketSwitchCapable build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketSwitchCapable>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketSwitchCapable,IllegalArgumentException>
-
-