Class CLinkstateDestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.destination.CLinkstateDestinationBuilder
-
@Generated("mdsal-binding-generator") public class CLinkstateDestinationBuilder extends Object
Class that buildsCLinkstateDestination
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:
CLinkstateDestination createCLinkstateDestination(int fooXyzzy, int barBaz) { return new CLinkstateDestinationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CLinkstateDestination, 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:
CLinkstateDestination
- 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 CLinkstateDestinationBuilder()
Construct an empty builder.CLinkstateDestinationBuilder(Linkstate arg)
Construct a new builder initialized from specifiedLinkstate
.CLinkstateDestinationBuilder(CLinkstateDestination base)
Construct a builder initialized with state from specifiedCLinkstateDestination
.CLinkstateDestinationBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.CLinkstateDestinationBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CLinkstateDestinationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull CLinkstateDestination
build()
A newCLinkstateDestination
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Identifier
getIdentifier()
Return current value associated with the property corresponding toLinkstate.getIdentifier()
.ObjectType
getObjectType()
Return current value associated with the property corresponding toLinkstate.getObjectType()
.PathId
getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.ProtocolId
getProtocolId()
Return current value associated with the property corresponding toLinkstate.getProtocolId()
.RouteDistinguisher
getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.CLinkstateDestinationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination>> augmentationType)
Remove an augmentation from this builder's product.CLinkstateDestinationBuilder
setIdentifier(Identifier value)
Set the property corresponding toLinkstate.getIdentifier()
to the specified value.CLinkstateDestinationBuilder
setObjectType(ObjectType value)
Set the property corresponding toLinkstate.getObjectType()
to the specified value.CLinkstateDestinationBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.CLinkstateDestinationBuilder
setProtocolId(ProtocolId value)
Set the property corresponding toLinkstate.getProtocolId()
to the specified value.CLinkstateDestinationBuilder
setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.
-
-
-
Constructor Detail
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder()
Construct an empty builder.
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(Linkstate arg)
Construct a new builder initialized from specifiedLinkstate
.- Parameters:
arg
- Linkstate from which the builder should be initialized
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(CLinkstateDestination base)
Construct a builder initialized with state from specifiedCLinkstateDestination
.- Parameters:
base
- CLinkstateDestination 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
-
getIdentifier
public Identifier getIdentifier()
Return current value associated with the property corresponding toLinkstate.getIdentifier()
.- Returns:
- current value
-
getObjectType
public ObjectType getObjectType()
Return current value associated with the property corresponding toLinkstate.getObjectType()
.- Returns:
- current value
-
getPathId
public PathId getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getProtocolId
public ProtocolId getProtocolId()
Return current value associated with the property corresponding toLinkstate.getProtocolId()
.- Returns:
- current value
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination>> 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
-
setIdentifier
public CLinkstateDestinationBuilder setIdentifier(Identifier value)
Set the property corresponding toLinkstate.getIdentifier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setObjectType
public CLinkstateDestinationBuilder setObjectType(ObjectType value)
Set the property corresponding toLinkstate.getObjectType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathId
public CLinkstateDestinationBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtocolId
public CLinkstateDestinationBuilder setProtocolId(ProtocolId value)
Set the property corresponding toLinkstate.getProtocolId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteDistinguisher
public CLinkstateDestinationBuilder setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CLinkstateDestinationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination> 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 CLinkstateDestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination>> 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 CLinkstateDestination build()
A newCLinkstateDestination
instance.- Returns:
- A new
CLinkstateDestination
instance.
-
-