Class VertexBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.graph.topology.graph.VertexBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Vertex>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Vertex,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VertexBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Vertex>
Class that buildsVertexBuilder
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:
VertexBuilder createTarget(int fooXyzzy, int barBaz) { return new VertexBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VertexBuilder, 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:
VertexBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VertexBuilder()
VertexBuilder(Vertex base)
VertexBuilder(Vertex arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VertexBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Vertex> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vertex>>
E$$augmentation(Class<E$$> augmentationType)
Vertex
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getAsn()
String
getName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getRouterId()
Srgb
getSrgb()
org.opendaylight.yangtools.yang.common.Uint64
getVertexId()
Vertex.VertexType
getVertexType()
VertexKey
key()
VertexBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vertex>> augmentationType)
Remove an augmentation from this builder's product.VertexBuilder
setAsn(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAsn(Uint32)
instead.VertexBuilder
setAsn(org.opendaylight.yangtools.yang.common.Uint32 value)
VertexBuilder
setName(String value)
VertexBuilder
setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
VertexBuilder
setSrgb(Srgb value)
VertexBuilder
setVertexId(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVertexId(Uint64)
instead.VertexBuilder
setVertexId(org.opendaylight.yangtools.yang.common.Uint64 value)
VertexBuilder
setVertexType(Vertex.VertexType value)
VertexBuilder
withKey(VertexKey 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.Vertex
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public VertexKey key()
-
getAsn
public org.opendaylight.yangtools.yang.common.Uint32 getAsn()
-
getName
public String getName()
-
getRouterId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getRouterId()
-
getSrgb
public Srgb getSrgb()
-
getVertexId
public org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
-
getVertexType
public Vertex.VertexType getVertexType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Vertex>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public VertexBuilder withKey(VertexKey key)
-
setAsn
public VertexBuilder setAsn(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setAsn
@Deprecated(forRemoval=true) public VertexBuilder setAsn(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAsn(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setName
public VertexBuilder setName(String value)
-
setRouterId
public VertexBuilder setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setSrgb
public VertexBuilder setSrgb(Srgb value)
-
setVertexId
public VertexBuilder setVertexId(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setVertexId
@Deprecated(forRemoval=true) public VertexBuilder setVertexId(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVertexId(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVertexType
public VertexBuilder setVertexType(Vertex.VertexType value)
-
addAugmentation
public VertexBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Vertex> 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 VertexBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Vertex>> 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 Vertex build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Vertex>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Vertex,IllegalArgumentException>
-
-