Class PrefixBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.graph.topology.graph.PrefixBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Prefix>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Prefix,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PrefixBuilder extends 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)
PrefixBuilder(Prefix arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PrefixBuilder
addAugmentation(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(Class<E$$> augmentationType)
Prefix
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
org.opendaylight.yangtools.yang.common.Uint32
getPrefixSid()
org.opendaylight.yangtools.yang.common.Uint64
getVertexId()
Boolean
isNodeSid()
PrefixKey
key()
PrefixBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType)
PrefixBuilder
setNodeSid(Boolean value)
PrefixBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
PrefixBuilder
setPrefixSid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPrefixSid(Uint32)} instead.PrefixBuilder
setPrefixSid(org.opendaylight.yangtools.yang.common.Uint32 value)
PrefixBuilder
setVertexId(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVertexId(Uint64)} instead.PrefixBuilder
setVertexId(org.opendaylight.yangtools.yang.common.Uint64 value)
PrefixBuilder
withKey(PrefixKey key)
-
-
-
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.graph.rev191125.Prefix
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public PrefixKey key()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
-
getPrefixSid
public org.opendaylight.yangtools.yang.common.Uint32 getPrefixSid()
-
getVertexId
public org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
-
isNodeSid
public Boolean isNodeSid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PrefixBuilder withKey(PrefixKey key)
-
setPrefix
public PrefixBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setPrefixSid
public PrefixBuilder setPrefixSid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPrefixSid
@Deprecated(forRemoval=true) public PrefixBuilder setPrefixSid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPrefixSid(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVertexId
public PrefixBuilder setVertexId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setVertexId
@Deprecated(forRemoval=true) public PrefixBuilder setVertexId(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVertexId(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNodeSid
public PrefixBuilder setNodeSid(Boolean value)
-
addAugmentation
public PrefixBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> augmentationValue)
-
removeAugmentation
public PrefixBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType)
-
build
public Prefix build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Prefix>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Prefix,IllegalArgumentException>
-
-