Class PrefixesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.operational.rev151009.bgp.neighbor.prefix.counters_state.PrefixesBuilder
-
@Generated("mdsal-binding-generator") public class PrefixesBuilder extends Object
Class that buildsPrefixes
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:
Prefixes createPrefixes(int fooXyzzy, int barBaz) { return new PrefixesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Prefixes, 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:
Prefixes
- 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 PrefixesBuilder()
Construct an empty builder.PrefixesBuilder(Prefixes base)
Construct a builder initialized with state from specifiedPrefixes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Prefixes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefixes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Prefixes
build()
A newPrefixes
instance.org.opendaylight.yangtools.yang.common.Uint32
getInstalled()
Return current value associated with the property corresponding toPrefixes.getInstalled()
.org.opendaylight.yangtools.yang.common.Uint32
getReceived()
Return current value associated with the property corresponding toPrefixes.getReceived()
.org.opendaylight.yangtools.yang.common.Uint32
getSent()
Return current value associated with the property corresponding toPrefixes.getSent()
.PrefixesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefixes>> augmentationType)
Remove an augmentation from this builder's product.PrefixesBuilder
setInstalled(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPrefixes.getInstalled()
to the specified value.PrefixesBuilder
setReceived(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPrefixes.getReceived()
to the specified value.PrefixesBuilder
setSent(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPrefixes.getSent()
to the specified value.
-
-
-
Method Detail
-
getInstalled
public org.opendaylight.yangtools.yang.common.Uint32 getInstalled()
Return current value associated with the property corresponding toPrefixes.getInstalled()
.- Returns:
- current value
-
getReceived
public org.opendaylight.yangtools.yang.common.Uint32 getReceived()
Return current value associated with the property corresponding toPrefixes.getReceived()
.- Returns:
- current value
-
getSent
public org.opendaylight.yangtools.yang.common.Uint32 getSent()
Return current value associated with the property corresponding toPrefixes.getSent()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefixes>> 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
-
setInstalled
public PrefixesBuilder setInstalled(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPrefixes.getInstalled()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReceived
public PrefixesBuilder setReceived(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPrefixes.getReceived()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSent
public PrefixesBuilder setSent(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toPrefixes.getSent()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PrefixesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Prefixes> 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 PrefixesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefixes>> 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
-
-