Class PrefixBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.prefix.lists.prefix.list.prefixes.PrefixBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Prefix>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Prefix,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PrefixBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Prefix>
Class that buildsPrefixBuilder
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:
PrefixBuilder createTarget(int fooXyzzy, int barBaz) { return new PrefixBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixBuilder, 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:
PrefixBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixBuilder()
PrefixBuilder(Prefix base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PrefixBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Prefix
build()
PrefixFilter
getPrefixFilter()
org.opendaylight.yangtools.yang.common.Uint16
getSeqNr()
PrefixKey
key()
PrefixBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType)
PrefixBuilder
setPrefixFilter(PrefixFilter value)
PrefixBuilder
setSeqNr(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSeqNr(Uint16)} instead.PrefixBuilder
setSeqNr(org.opendaylight.yangtools.yang.common.Uint16 value)
PrefixBuilder
withKey(PrefixKey key)
-
-
-
Constructor Detail
-
PrefixBuilder
public PrefixBuilder()
-
PrefixBuilder
public PrefixBuilder(Prefix base)
-
-
Method Detail
-
key
public PrefixKey key()
-
getPrefixFilter
public PrefixFilter getPrefixFilter()
-
getSeqNr
public org.opendaylight.yangtools.yang.common.Uint16 getSeqNr()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public PrefixBuilder withKey(PrefixKey key)
-
setPrefixFilter
public PrefixBuilder setPrefixFilter(PrefixFilter value)
-
setSeqNr
public PrefixBuilder setSeqNr(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSeqNr
@Deprecated(forRemoval=true) public PrefixBuilder setSeqNr(java.lang.Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSeqNr(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public PrefixBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> augmentationValue)
-
removeAugmentation
public PrefixBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType)
-
-