Class LinkstateRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes.linkstate.routes.LinkstateRouteBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LinkstateRoute>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LinkstateRoute,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LinkstateRouteBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LinkstateRoute>
Class that buildsLinkstateRouteBuilder
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:
LinkstateRouteBuilder createTarget(int fooXyzzy, int barBaz) { return new LinkstateRouteBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LinkstateRouteBuilder, 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:
LinkstateRouteBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LinkstateRouteBuilder()
LinkstateRouteBuilder(Linkstate arg)
LinkstateRouteBuilder(LinkstateRoute base)
LinkstateRouteBuilder(PathAttributes arg)
LinkstateRouteBuilder(PathIdGrouping arg)
LinkstateRouteBuilder(Route arg)
LinkstateRouteBuilder(RouteDistinguisherGrouping arg)
-
Method Summary
-
-
-
Constructor Detail
-
LinkstateRouteBuilder
public LinkstateRouteBuilder()
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(Linkstate arg)
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(RouteDistinguisherGrouping arg)
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(Route arg)
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(PathIdGrouping arg)
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(PathAttributes arg)
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(LinkstateRoute 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.PathAttributes
- 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.rib.rev180329.Route
- 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 or has property with incompatible value
-
key
public LinkstateRouteKey key()
-
getAttributes
public Attributes getAttributes()
-
getIdentifier
public Identifier getIdentifier()
-
getObjectType
public ObjectType getObjectType()
-
getPathId
public PathId getPathId()
-
getProtocolId
public ProtocolId getProtocolId()
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
-
getRouteKey
public String getRouteKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public LinkstateRouteBuilder withKey(LinkstateRouteKey key)
-
setAttributes
public LinkstateRouteBuilder setAttributes(Attributes value)
-
setIdentifier
public LinkstateRouteBuilder setIdentifier(Identifier value)
-
setObjectType
public LinkstateRouteBuilder setObjectType(ObjectType value)
-
setPathId
public LinkstateRouteBuilder setPathId(PathId value)
-
setProtocolId
public LinkstateRouteBuilder setProtocolId(ProtocolId value)
-
setRouteDistinguisher
public LinkstateRouteBuilder setRouteDistinguisher(RouteDistinguisher value)
-
setRouteKey
public LinkstateRouteBuilder setRouteKey(String value)
-
addAugmentation
public LinkstateRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute> 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 LinkstateRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute>> 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 LinkstateRoute build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LinkstateRoute>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LinkstateRoute,IllegalArgumentException>
-
-