Class LocalNodeDescriptorsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.link._case.LocalNodeDescriptorsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LocalNodeDescriptors>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LocalNodeDescriptors,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LocalNodeDescriptorsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LocalNodeDescriptors>
Class that buildsLocalNodeDescriptors
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:
LocalNodeDescriptors createLocalNodeDescriptors(int fooXyzzy, int barBaz) { return new LocalNodeDescriptorsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LocalNodeDescriptors, 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:
LocalNodeDescriptors
,Builder
-
-
Constructor Summary
Constructors Constructor Description LocalNodeDescriptorsBuilder()
LocalNodeDescriptorsBuilder(EpeNodeDescriptors arg)
LocalNodeDescriptorsBuilder(LocalNodeDescriptors base)
LocalNodeDescriptorsBuilder(NodeIdentifier arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LocalNodeDescriptorsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors>>
E$$augmentation(Class<E$$> augmentationType)
LocalNodeDescriptors
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AreaIdentifier
getAreaId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getAsNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getBgpRouterId()
CRouterIdentifier
getCRouterIdentifier()
DomainIdentifier
getDomainId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getMemberAsn()
LocalNodeDescriptorsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors>> augmentationType)
Remove an augmentation from this builder's product.LocalNodeDescriptorsBuilder
setAreaId(AreaIdentifier value)
LocalNodeDescriptorsBuilder
setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
LocalNodeDescriptorsBuilder
setBgpRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
LocalNodeDescriptorsBuilder
setCRouterIdentifier(CRouterIdentifier value)
LocalNodeDescriptorsBuilder
setDomainId(DomainIdentifier value)
LocalNodeDescriptorsBuilder
setMemberAsn(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
-
-
Constructor Detail
-
LocalNodeDescriptorsBuilder
public LocalNodeDescriptorsBuilder()
-
LocalNodeDescriptorsBuilder
public LocalNodeDescriptorsBuilder(NodeIdentifier arg)
-
LocalNodeDescriptorsBuilder
public LocalNodeDescriptorsBuilder(EpeNodeDescriptors arg)
-
LocalNodeDescriptorsBuilder
public LocalNodeDescriptorsBuilder(LocalNodeDescriptors base)
-
-
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:- NodeIdentifier
- EpeNodeDescriptors
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAreaId
public AreaIdentifier getAreaId()
-
getAsNumber
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAsNumber()
-
getBgpRouterId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpRouterId()
-
getCRouterIdentifier
public CRouterIdentifier getCRouterIdentifier()
-
getDomainId
public DomainIdentifier getDomainId()
-
getMemberAsn
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getMemberAsn()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors>> E$$ augmentation(Class<E$$> augmentationType)
-
setAreaId
public LocalNodeDescriptorsBuilder setAreaId(AreaIdentifier value)
-
setAsNumber
public LocalNodeDescriptorsBuilder setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
setBgpRouterId
public LocalNodeDescriptorsBuilder setBgpRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setCRouterIdentifier
public LocalNodeDescriptorsBuilder setCRouterIdentifier(CRouterIdentifier value)
-
setDomainId
public LocalNodeDescriptorsBuilder setDomainId(DomainIdentifier value)
-
setMemberAsn
public LocalNodeDescriptorsBuilder setMemberAsn(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
addAugmentation
public LocalNodeDescriptorsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors> 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 LocalNodeDescriptorsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors>> 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 LocalNodeDescriptors build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LocalNodeDescriptors>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LocalNodeDescriptors,IllegalArgumentException>
-
-