Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.association.object
Class AssociationObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.association.object.AssociationObjectBuilder
-
@Generated("mdsal-binding-generator") public class AssociationObjectBuilder extends Object
Class that buildsAssociationObject
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:
AssociationObject createAssociationObject(int fooXyzzy, int barBaz) { return new AssociationObjectBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AssociationObject, 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:
AssociationObject
- 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 AssociationObjectBuilder()
Construct an empty builder.AssociationObjectBuilder(AssociationObject base)
Construct a builder initialized with state from specifiedAssociationObject
.AssociationObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssociationObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AssociationObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociationObject>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull AssociationObject
build()
A newAssociationObject
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getAssociationId()
Return current value associated with the property corresponding toAssociationObject.getAssociationId()
.AssociationType
getAssociationType()
Return current value associated with the property corresponding toAssociationObject.getAssociationType()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getIpAddress()
Return current value associated with the property corresponding toAssociationObject.getIpAddress()
.AssociationObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociationObject>> augmentationType)
Remove an augmentation from this builder's product.AssociationObjectBuilder
setAssociationId(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toAssociationObject.getAssociationId()
to the specified value.AssociationObjectBuilder
setAssociationType(AssociationType value)
Set the property corresponding toAssociationObject.getAssociationType()
to the specified value.AssociationObjectBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toAssociationObject.getIpAddress()
to the specified value.
-
-
-
Constructor Detail
-
AssociationObjectBuilder
public AssociationObjectBuilder()
Construct an empty builder.
-
AssociationObjectBuilder
public AssociationObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.- Parameters:
arg
- RsvpTeObject from which the builder should be initialized
-
AssociationObjectBuilder
public AssociationObjectBuilder(AssociationObject base)
Construct a builder initialized with state from specifiedAssociationObject
.- Parameters:
base
- AssociationObject from which the builder should be initialized
-
-
Method Detail
-
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
-
getAssociationId
public org.opendaylight.yangtools.yang.common.Uint16 getAssociationId()
Return current value associated with the property corresponding toAssociationObject.getAssociationId()
.- Returns:
- current value
-
getAssociationType
public AssociationType getAssociationType()
Return current value associated with the property corresponding toAssociationObject.getAssociationType()
.- Returns:
- current value
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getIpAddress()
Return current value associated with the property corresponding toAssociationObject.getIpAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociationObject>> 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 AssociationObjectBuilder setAssociationId(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toAssociationObject.getAssociationId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAssociationType
public AssociationObjectBuilder setAssociationType(AssociationType value)
Set the property corresponding toAssociationObject.getAssociationType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpAddress
public AssociationObjectBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toAssociationObject.getIpAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AssociationObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AssociationObject> 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 AssociationObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AssociationObject>> 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 AssociationObject build()
A newAssociationObject
instance.- Returns:
- A new
AssociationObject
instance.
-
-