Class PrefixListBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.prefix.lists.PrefixListBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PrefixList>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PrefixList,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PrefixListBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<PrefixList>
Class that buildsPrefixListBuilder
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:
PrefixListBuilder createTarget(int fooXyzzy, int barBaz) { return new PrefixListBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixListBuilder, 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:
PrefixListBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixListBuilder()
PrefixListBuilder(PrefixList base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixListBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixList> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixList>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
PrefixList
build()
Prefixes
getPrefixes()
java.lang.String
getPrefixListName()
PrefixListKey
key()
PrefixListBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixList>> augmentationType)
Remove an augmentation from this builder's product.PrefixListBuilder
setPrefixes(Prefixes value)
PrefixListBuilder
setPrefixListName(java.lang.String value)
PrefixListBuilder
withKey(PrefixListKey key)
-
-
-
Constructor Detail
-
PrefixListBuilder
public PrefixListBuilder()
-
PrefixListBuilder
public PrefixListBuilder(PrefixList base)
-
-
Method Detail
-
key
public PrefixListKey key()
-
getPrefixListName
public java.lang.String getPrefixListName()
-
getPrefixes
public Prefixes getPrefixes()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixList>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public PrefixListBuilder withKey(PrefixListKey key)
-
setPrefixListName
public PrefixListBuilder setPrefixListName(java.lang.String value)
-
setPrefixes
public PrefixListBuilder setPrefixes(Prefixes value)
-
addAugmentation
public PrefixListBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixList> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public PrefixListBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixList>> 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 PrefixList build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PrefixList>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PrefixList,java.lang.IllegalArgumentException>
-
-