Class InterfaceLldpBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.port._interface.attributes.InterfaceLldpBuilder
-
@Generated("mdsal-binding-generator") public class InterfaceLldpBuilder extends Object
Class that buildsInterfaceLldp
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:
InterfaceLldp createInterfaceLldp(int fooXyzzy, int barBaz) { return new InterfaceLldpBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InterfaceLldp, 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:
InterfaceLldp
- 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 InterfaceLldpBuilder()
Construct an empty builder.InterfaceLldpBuilder(InterfaceLldp base)
Construct a builder initialized with state from specifiedInterfaceLldp
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InterfaceLldpBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceLldp> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceLldp>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull InterfaceLldp
build()
A newInterfaceLldp
instance.String
getLldpKey()
Return current value associated with the property corresponding toInterfaceLldp.getLldpKey()
.String
getLldpValue()
Return current value associated with the property corresponding toInterfaceLldp.getLldpValue()
.InterfaceLldpKey
key()
Return current value associated with the property corresponding toInterfaceLldp.key()
.InterfaceLldpBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceLldp>> augmentationType)
Remove an augmentation from this builder's product.InterfaceLldpBuilder
setLldpKey(String value)
Set the property corresponding toInterfaceLldp.getLldpKey()
to the specified value.InterfaceLldpBuilder
setLldpValue(String value)
Set the property corresponding toInterfaceLldp.getLldpValue()
to the specified value.InterfaceLldpBuilder
withKey(InterfaceLldpKey key)
-
-
-
Constructor Detail
-
InterfaceLldpBuilder
public InterfaceLldpBuilder()
Construct an empty builder.
-
InterfaceLldpBuilder
public InterfaceLldpBuilder(InterfaceLldp base)
Construct a builder initialized with state from specifiedInterfaceLldp
.- Parameters:
base
- InterfaceLldp from which the builder should be initialized
-
-
Method Detail
-
key
public InterfaceLldpKey key()
Return current value associated with the property corresponding toInterfaceLldp.key()
.- Returns:
- current value
-
getLldpKey
public String getLldpKey()
Return current value associated with the property corresponding toInterfaceLldp.getLldpKey()
.- Returns:
- current value
-
getLldpValue
public String getLldpValue()
Return current value associated with the property corresponding toInterfaceLldp.getLldpValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceLldp>> 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
-
withKey
public InterfaceLldpBuilder withKey(InterfaceLldpKey key)
-
setLldpKey
public InterfaceLldpBuilder setLldpKey(String value)
Set the property corresponding toInterfaceLldp.getLldpKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLldpValue
public InterfaceLldpBuilder setLldpValue(String value)
Set the property corresponding toInterfaceLldp.getLldpValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public InterfaceLldpBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceLldp> 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 InterfaceLldpBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InterfaceLldp>> 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 InterfaceLldp build()
A newInterfaceLldp
instance.- Returns:
- A new
InterfaceLldp
instance.
-
-