Class CLinkstateDestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.destination.CLinkstateDestinationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<CLinkstateDestination>
,org.opendaylight.yangtools.concepts.CheckedBuilder<CLinkstateDestination,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class CLinkstateDestinationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<CLinkstateDestination>
Class that buildsCLinkstateDestinationBuilder
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:
CLinkstateDestinationBuilder createTarget(int fooXyzzy, int barBaz) { return new CLinkstateDestinationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CLinkstateDestinationBuilder, 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 oportunities, 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:
CLinkstateDestinationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CLinkstateDestinationBuilder()
CLinkstateDestinationBuilder(Linkstate arg)
CLinkstateDestinationBuilder(CLinkstateDestination base)
CLinkstateDestinationBuilder(PathIdGrouping arg)
CLinkstateDestinationBuilder(RouteDistinguisherGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CLinkstateDestinationBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
CLinkstateDestination
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Identifier
getIdentifier()
ObjectType
getObjectType()
PathId
getPathId()
ProtocolId
getProtocolId()
RouteDistinguisher
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)
CLinkstateDestinationBuilder
setObjectType(ObjectType value)
CLinkstateDestinationBuilder
setPathId(PathId value)
CLinkstateDestinationBuilder
setProtocolId(ProtocolId value)
CLinkstateDestinationBuilder
setRouteDistinguisher(RouteDistinguisher value)
-
-
-
Constructor Detail
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder()
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(Linkstate arg)
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(RouteDistinguisherGrouping arg)
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(PathIdGrouping arg)
-
CLinkstateDestinationBuilder
public CLinkstateDestinationBuilder(CLinkstateDestination base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathIdGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.RouteDistinguisherGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.Linkstate
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getIdentifier
public Identifier getIdentifier()
-
getObjectType
public ObjectType getObjectType()
-
getPathId
public PathId getPathId()
-
getProtocolId
public ProtocolId getProtocolId()
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination>> E$$ augmentation(Class<E$$> augmentationType)
-
setIdentifier
public CLinkstateDestinationBuilder setIdentifier(Identifier value)
-
setObjectType
public CLinkstateDestinationBuilder setObjectType(ObjectType value)
-
setPathId
public CLinkstateDestinationBuilder setPathId(PathId value)
-
setProtocolId
public CLinkstateDestinationBuilder setProtocolId(ProtocolId value)
-
setRouteDistinguisher
public CLinkstateDestinationBuilder setRouteDistinguisher(RouteDistinguisher value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public CLinkstateDestinationBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CLinkstateDestination> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 CLinkstateDestination build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<CLinkstateDestination>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<CLinkstateDestination,IllegalArgumentException>
-
-