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
-
@Generated("mdsal-binding-generator") public class PacketSwitchCapableBuilder extends Object
Class that buildsPacketSwitchCapable
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:
PacketSwitchCapable createPacketSwitchCapable(int fooXyzzy, int barBaz) { return new PacketSwitchCapableBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketSwitchCapable, 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 opportunities, 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:
PacketSwitchCapable
- 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
-
-
Constructor Summary
Constructors Constructor Description PacketSwitchCapableBuilder()
Construct an empty builder.PacketSwitchCapableBuilder(PacketSwitchCapable base)
Construct a builder initialized with state from specifiedPacketSwitchCapable
.
-
Method Summary
All Methods Instance Methods Concrete 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)
Return the specified augmentation, if it is present in this builder.@NonNull PacketSwitchCapable
build()
A newPacketSwitchCapable
instance.org.opendaylight.yangtools.yang.common.Uint16
getInterfaceMtu()
Return current value associated with the property corresponding toPacketSwitchCapable.getInterfaceMtu()
.org.opendaylight.yangtools.yang.common.Decimal64
getMinimumLspBandwidth()
Return current value associated with the property corresponding toPacketSwitchCapable.getMinimumLspBandwidth()
.PacketSwitchCapableBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable>> augmentationType)
Remove an augmentation from this builder's product.PacketSwitchCapableBuilder
setInterfaceMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPacketSwitchCapable.getInterfaceMtu()
to the specified value.PacketSwitchCapableBuilder
setMinimumLspBandwidth(org.opendaylight.yangtools.yang.common.Decimal64 value)
Set the property corresponding toPacketSwitchCapable.getMinimumLspBandwidth()
to the specified value.
-
-
-
Constructor Detail
-
PacketSwitchCapableBuilder
public PacketSwitchCapableBuilder()
Construct an empty builder.
-
PacketSwitchCapableBuilder
public PacketSwitchCapableBuilder(PacketSwitchCapable base)
Construct a builder initialized with state from specifiedPacketSwitchCapable
.- Parameters:
base
- PacketSwitchCapable from which the builder should be initialized
-
-
Method Detail
-
getInterfaceMtu
public org.opendaylight.yangtools.yang.common.Uint16 getInterfaceMtu()
Return current value associated with the property corresponding toPacketSwitchCapable.getInterfaceMtu()
.- Returns:
- current value
-
getMinimumLspBandwidth
public org.opendaylight.yangtools.yang.common.Decimal64 getMinimumLspBandwidth()
Return current value associated with the property corresponding toPacketSwitchCapable.getMinimumLspBandwidth()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketSwitchCapable>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setInterfaceMtu
public PacketSwitchCapableBuilder setInterfaceMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPacketSwitchCapable.getInterfaceMtu()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMinimumLspBandwidth
public PacketSwitchCapableBuilder setMinimumLspBandwidth(org.opendaylight.yangtools.yang.common.Decimal64 value)
Set the property corresponding toPacketSwitchCapable.getMinimumLspBandwidth()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull PacketSwitchCapable build()
A newPacketSwitchCapable
instance.- Returns:
- A new
PacketSwitchCapable
instance.
-
-