Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.protocol.match.fields
Class PbbBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.protocol.match.fields.PbbBuilder
-
@Generated("mdsal-binding-generator") public class PbbBuilder extends Object
Class that buildsPbb
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:
Pbb createPbb(int fooXyzzy, int barBaz) { return new PbbBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Pbb, 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:
Pbb
- 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 PbbBuilder()
Construct an empty builder.PbbBuilder(Pbb base)
Construct a builder initialized with state from specifiedPbb
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PbbBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Pbb> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pbb>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Pbb
build()
A newPbb
instance.org.opendaylight.yangtools.yang.common.Uint32
getPbbIsid()
Return current value associated with the property corresponding toPbb.getPbbIsid()
.org.opendaylight.yangtools.yang.common.Uint32
getPbbMask()
Return current value associated with the property corresponding toPbb.getPbbMask()
.PbbBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pbb>> augmentationType)
Remove an augmentation from this builder's product.PbbBuilder
setPbbIsid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPbb.getPbbIsid()
to the specified value.PbbBuilder
setPbbMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPbb.getPbbMask()
to the specified value.
-
-
-
Method Detail
-
getPbbIsid
public org.opendaylight.yangtools.yang.common.Uint32 getPbbIsid()
Return current value associated with the property corresponding toPbb.getPbbIsid()
.- Returns:
- current value
-
getPbbMask
public org.opendaylight.yangtools.yang.common.Uint32 getPbbMask()
Return current value associated with the property corresponding toPbb.getPbbMask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pbb>> 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
-
setPbbIsid
public PbbBuilder setPbbIsid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPbb.getPbbIsid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPbbMask
public PbbBuilder setPbbMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPbb.getPbbMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PbbBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Pbb> 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 PbbBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pbb>> 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
-
-