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>
@Generated("mdsal-binding-generator") public class PrefixBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Prefix>
Class that buildsPrefix
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:
Prefix createPrefix(int fooXyzzy, int barBaz) { return new PrefixBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Prefix, 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 opportunities, 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:
Prefix
,Builder
-
-
Constructor Summary
Constructors Constructor Description PrefixBuilder()
PrefixBuilder(Prefix base)
PrefixBuilder(Prefix arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> augmentation)
Add an augmentation to this builder's product.<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.Boolean
getNodeSid()
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()
PrefixKey
key()
PrefixBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType)
Remove an augmentation from this builder's product.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(org.opendaylight.yangtools.yang.common.Uint32 value)
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 or has property with incompatible value
-
key
public PrefixKey key()
-
getNodeSid
public Boolean getNodeSid()
-
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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public PrefixBuilder withKey(PrefixKey key)
-
setNodeSid
public PrefixBuilder setNodeSid(Boolean value)
-
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)
-
setVertexId
public PrefixBuilder setVertexId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
addAugmentation
public PrefixBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> 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 PrefixBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> 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 Prefix build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Prefix>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Prefix,IllegalArgumentException>
-
-