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