Class As4SpecificCommonBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.as._4.spec.common.As4SpecificCommonBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<As4SpecificCommon>
,org.opendaylight.yangtools.concepts.CheckedBuilder<As4SpecificCommon,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class As4SpecificCommonBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<As4SpecificCommon>
Class that buildsAs4SpecificCommon
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:
As4SpecificCommon createAs4SpecificCommon(int fooXyzzy, int barBaz) { return new As4SpecificCommonBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of As4SpecificCommon, 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:
As4SpecificCommon
,Builder
-
-
Constructor Summary
Constructors Constructor Description As4SpecificCommonBuilder()
As4SpecificCommonBuilder(As4SpecificCommon base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description As4SpecificCommonBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<As4SpecificCommon> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<As4SpecificCommon>>
E$$augmentation(Class<E$$> augmentationType)
As4SpecificCommon
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getAsNumber()
org.opendaylight.yangtools.yang.common.Uint16
getLocalAdministrator()
As4SpecificCommonBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<As4SpecificCommon>> augmentationType)
Remove an augmentation from this builder's product.As4SpecificCommonBuilder
setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
As4SpecificCommonBuilder
setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
As4SpecificCommonBuilder
public As4SpecificCommonBuilder()
-
As4SpecificCommonBuilder
public As4SpecificCommonBuilder(As4SpecificCommon base)
-
-
Method Detail
-
getAsNumber
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAsNumber()
-
getLocalAdministrator
public org.opendaylight.yangtools.yang.common.Uint16 getLocalAdministrator()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<As4SpecificCommon>> E$$ augmentation(Class<E$$> augmentationType)
-
setAsNumber
public As4SpecificCommonBuilder setAsNumber(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
-
setLocalAdministrator
public As4SpecificCommonBuilder setLocalAdministrator(org.opendaylight.yangtools.yang.common.Uint16 value)
-
addAugmentation
public As4SpecificCommonBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<As4SpecificCommon> 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 As4SpecificCommonBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<As4SpecificCommon>> 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 As4SpecificCommon build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<As4SpecificCommon>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<As4SpecificCommon,IllegalArgumentException>
-
-