Class CommunitiesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.CommunitiesBuilder
Class that builds
Communities
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:
Communities createCommunities(int fooXyzzy, int barBaz) {
return new CommunitiesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Communities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedCommunities
.Construct a new builder initialized from specifiedCommunity
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Communities> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Communities>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Communities
build()
A newCommunities
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
Return current value associated with the property corresponding toCommunity.getAsNumber()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toCommunity.getSemantics()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Communities>> augmentationType) Remove an augmentation from this builder's product.setAsNumber
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value) Set the property corresponding toCommunity.getAsNumber()
to the specified value.setSemantics
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toCommunity.getSemantics()
to the specified value.
-
Constructor Details
-
CommunitiesBuilder
public CommunitiesBuilder()Construct an empty builder. -
CommunitiesBuilder
Construct a new builder initialized from specifiedCommunity
.- Parameters:
arg
- Community from which the builder should be initialized
-
CommunitiesBuilder
Construct a builder initialized with state from specifiedCommunities
.- Parameters:
base
- Communities from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAsNumber
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAsNumber()Return current value associated with the property corresponding toCommunity.getAsNumber()
.- Returns:
- current value
-
getSemantics
public org.opendaylight.yangtools.yang.common.Uint16 getSemantics()Return current value associated with the property corresponding toCommunity.getSemantics()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Communities>> 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
-
setAsNumber
public CommunitiesBuilder setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value) Set the property corresponding toCommunity.getAsNumber()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSemantics
Set the property corresponding toCommunity.getSemantics()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CommunitiesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Communities> 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 CommunitiesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Communities>> 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
A newCommunities
instance.- Returns:
- A new
Communities
instance.
-