Class IgpNodeAttributesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes.IgpNodeAttributesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IgpNodeAttributes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IgpNodeAttributes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IgpNodeAttributesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IgpNodeAttributes>
Class that buildsIgpNodeAttributes
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:
IgpNodeAttributes createIgpNodeAttributes(int fooXyzzy, int barBaz) { return new IgpNodeAttributesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IgpNodeAttributes, 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:
IgpNodeAttributes
,Builder
-
-
Constructor Summary
Constructors Constructor Description IgpNodeAttributesBuilder()
IgpNodeAttributesBuilder(IgpNodeAttributes base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IgpNodeAttributesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpNodeAttributes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpNodeAttributes>>
E$$augmentation(Class<E$$> augmentationType)
IgpNodeAttributes
build()
List<Class<? extends FlagIdentity>>
getFlag()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.DomainName
getName()
Map<PrefixKey,Prefix>
getPrefix()
List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress>
getRouterId()
IgpNodeAttributesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpNodeAttributes>> augmentationType)
Remove an augmentation from this builder's product.IgpNodeAttributesBuilder
setFlag(List<Class<? extends FlagIdentity>> values)
IgpNodeAttributesBuilder
setName(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.DomainName value)
IgpNodeAttributesBuilder
setPrefix(Map<PrefixKey,Prefix> values)
IgpNodeAttributesBuilder
setRouterId(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)
-
-
-
Constructor Detail
-
IgpNodeAttributesBuilder
public IgpNodeAttributesBuilder()
-
IgpNodeAttributesBuilder
public IgpNodeAttributesBuilder(IgpNodeAttributes base)
-
-
Method Detail
-
getFlag
public List<Class<? extends FlagIdentity>> getFlag()
-
getName
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.DomainName getName()
-
getRouterId
public List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getRouterId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpNodeAttributes>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlag
public IgpNodeAttributesBuilder setFlag(List<Class<? extends FlagIdentity>> values)
-
setName
public IgpNodeAttributesBuilder setName(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.DomainName value)
-
setPrefix
public IgpNodeAttributesBuilder setPrefix(Map<PrefixKey,Prefix> values)
-
setRouterId
public IgpNodeAttributesBuilder setRouterId(List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)
-
addAugmentation
public IgpNodeAttributesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IgpNodeAttributes> 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 IgpNodeAttributesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpNodeAttributes>> 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 IgpNodeAttributes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IgpNodeAttributes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IgpNodeAttributes,IllegalArgumentException>
-
-