Class LabeledUnicastRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.labeled.unicast.routes.list.LabeledUnicastRouteBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LabeledUnicastRoute>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LabeledUnicastRoute,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LabeledUnicastRouteBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LabeledUnicastRoute>
Class that buildsLabeledUnicastRouteBuilder
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:
LabeledUnicastRouteBuilder createTarget(int fooXyzzy, int barBaz) { return new LabeledUnicastRouteBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LabeledUnicastRouteBuilder, 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:
LabeledUnicastRouteBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LabeledUnicastRouteBuilder()
LabeledUnicastRouteBuilder(LabeledUnicastRoute base)
LabeledUnicastRouteBuilder(LabeledUnicast arg)
LabeledUnicastRouteBuilder(PathAttributes arg)
LabeledUnicastRouteBuilder(PathIdGrouping arg)
LabeledUnicastRouteBuilder(Route arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LabeledUnicastRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>>
E$$augmentation(Class<E$$> augmentationType)
LabeledUnicastRoute
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
List<LabelStack>
getLabelStack()
PathId
getPathId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
String
getRouteKey()
LabeledUnicastRouteKey
key()
LabeledUnicastRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>> augmentationType)
Remove an augmentation from this builder's product.LabeledUnicastRouteBuilder
setAttributes(Attributes value)
LabeledUnicastRouteBuilder
setLabelStack(List<LabelStack> values)
LabeledUnicastRouteBuilder
setPathId(PathId value)
LabeledUnicastRouteBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
LabeledUnicastRouteBuilder
setRouteKey(String value)
LabeledUnicastRouteBuilder
withKey(LabeledUnicastRouteKey key)
-
-
-
Constructor Detail
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder()
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(LabeledUnicast arg)
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(Route arg)
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(PathIdGrouping arg)
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(PathAttributes arg)
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(LabeledUnicastRoute 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.labeled.unicast.rev180329.LabeledUnicast
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public LabeledUnicastRouteKey key()
-
getAttributes
public Attributes getAttributes()
-
getLabelStack
public List<LabelStack> getLabelStack()
-
getPathId
public PathId getPathId()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
-
getRouteKey
public String getRouteKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public LabeledUnicastRouteBuilder withKey(LabeledUnicastRouteKey key)
-
setAttributes
public LabeledUnicastRouteBuilder setAttributes(Attributes value)
-
setLabelStack
public LabeledUnicastRouteBuilder setLabelStack(List<LabelStack> values)
-
setPathId
public LabeledUnicastRouteBuilder setPathId(PathId value)
-
setPrefix
public LabeledUnicastRouteBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setRouteKey
public LabeledUnicastRouteBuilder setRouteKey(String value)
-
addAugmentation
public LabeledUnicastRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute> 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 LabeledUnicastRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>> 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 LabeledUnicastRoute build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LabeledUnicastRoute>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LabeledUnicastRoute,IllegalArgumentException>
-
-