Class AssociationGroupBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.association.object.AssociationGroupBuilder
Class that builds
AssociationGroup
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:
AssociationGroup createAssociationGroup(int fooXyzzy, int barBaz) {
return new AssociationGroupBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of AssociationGroup, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedAssociationGroup
.Construct a new builder initialized from specifiedObjectHeader
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<AssociationGroup> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<AssociationGroup>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull AssociationGroup
build()
A newAssociationGroup
instance.static @NonNull AssociationGroup
empty()
Get empty instance of AssociationGroup.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toAssociationGroup.getAssociationId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
Return current value associated with the property corresponding toAssociationGroup.getAssociationSource()
.Return current value associated with the property corresponding toAssociationGroup.getAssociationTlvs()
.Return current value associated with the property corresponding toAssociationGroup.getAssociationType()
.Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Return current value associated with the property corresponding toAssociationGroup.getRemovalFlag()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<AssociationGroup>> augmentationType) Remove an augmentation from this builder's product.setAssociationId
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toAssociationGroup.getAssociationId()
to the specified value.setAssociationSource
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toAssociationGroup.getAssociationSource()
to the specified value.Set the property corresponding toAssociationGroup.getAssociationTlvs()
to the specified value.Set the property corresponding toAssociationGroup.getAssociationType()
to the specified value.Set the property corresponding toObjectHeader.getIgnore()
to the specified value.setProcessingRule
(Boolean value) Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.setRemovalFlag
(Boolean value) Set the property corresponding toAssociationGroup.getRemovalFlag()
to the specified value.
-
Constructor Details
-
AssociationGroupBuilder
public AssociationGroupBuilder()Construct an empty builder. -
AssociationGroupBuilder
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
AssociationGroupBuilder
Construct a builder initialized with state from specifiedAssociationGroup
.- Parameters:
base
- AssociationGroup from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Get empty instance of AssociationGroup.- Returns:
- An empty
AssociationGroup
-
getAssociationId
public org.opendaylight.yangtools.yang.common.Uint16 getAssociationId()Return current value associated with the property corresponding toAssociationGroup.getAssociationId()
.- Returns:
- current value
-
getAssociationSource
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAssociationSource()Return current value associated with the property corresponding toAssociationGroup.getAssociationSource()
.- Returns:
- current value
-
getAssociationTlvs
Return current value associated with the property corresponding toAssociationGroup.getAssociationTlvs()
.- Returns:
- current value
-
getAssociationType
Return current value associated with the property corresponding toAssociationGroup.getAssociationType()
.- Returns:
- current value
-
getIgnore
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getProcessingRule
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getRemovalFlag
Return current value associated with the property corresponding toAssociationGroup.getRemovalFlag()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<AssociationGroup>> 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
-
setAssociationId
public AssociationGroupBuilder setAssociationId(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toAssociationGroup.getAssociationId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAssociationSource
public AssociationGroupBuilder setAssociationSource(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value) Set the property corresponding toAssociationGroup.getAssociationSource()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAssociationTlvs
Set the property corresponding toAssociationGroup.getAssociationTlvs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAssociationType
Set the property corresponding toAssociationGroup.getAssociationType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemovalFlag
Set the property corresponding toAssociationGroup.getRemovalFlag()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AssociationGroupBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<AssociationGroup> 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 AssociationGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<AssociationGroup>> 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 newAssociationGroup
instance.- Returns:
- A new
AssociationGroup
instance.
-