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>
@Generated("mdsal-binding-generator") public class CLinkstateDestinationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<CLinkstateDestination>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description CLinkstateDestinationBuilder()
CLinkstateDestinationBuilder(Linkstate arg)
CLinkstateDestinationBuilder(CLinkstateDestination base)
CLinkstateDestinationBuilder(PathIdGrouping arg)
CLinkstateDestinationBuilder(RouteDistinguisherGrouping arg)
-
Method Summary
-
-
-
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:- PathIdGrouping
- RouteDistinguisherGrouping
- Linkstate
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
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
-
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>
-
-