Class OpenBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Open>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Open,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OpenBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Open>
Class that buildsOpenBuilder
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:
OpenBuilder createTarget(int fooXyzzy, int barBaz) { return new OpenBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OpenBuilder, 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:
OpenBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OpenBuilder()
OpenBuilder(Open base)
OpenBuilder(OpenMessage arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OpenBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Open> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>>
E$$augmentation(Class<E$$> augmentationType)
Open
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getBgpIdentifier()
List<BgpParameters>
getBgpParameters()
org.opendaylight.yangtools.yang.common.Uint16
getHoldTimer()
org.opendaylight.yangtools.yang.common.Uint16
getMyAsNumber()
ProtocolVersion
getVersion()
OpenBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>> augmentationType)
Remove an augmentation from this builder's product.OpenBuilder
setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
OpenBuilder
setBgpParameters(List<BgpParameters> values)
OpenBuilder
setHoldTimer(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHoldTimer(Uint16)
instead.OpenBuilder
setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
OpenBuilder
setMyAsNumber(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMyAsNumber(Uint16)
instead.OpenBuilder
setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
OpenBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
OpenBuilder
public OpenBuilder()
-
OpenBuilder
public OpenBuilder(OpenMessage arg)
-
OpenBuilder
public OpenBuilder(Open 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.OpenMessage
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBgpIdentifier
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpIdentifier()
-
getBgpParameters
public List<BgpParameters> getBgpParameters()
-
getHoldTimer
public org.opendaylight.yangtools.yang.common.Uint16 getHoldTimer()
-
getMyAsNumber
public org.opendaylight.yangtools.yang.common.Uint16 getMyAsNumber()
-
getVersion
public ProtocolVersion getVersion()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>> E$$ augmentation(Class<E$$> augmentationType)
-
setBgpIdentifier
public OpenBuilder setBgpIdentifier(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setBgpParameters
public OpenBuilder setBgpParameters(List<BgpParameters> values)
-
setHoldTimer
public OpenBuilder setHoldTimer(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHoldTimer
@Deprecated(forRemoval=true) public OpenBuilder setHoldTimer(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHoldTimer(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMyAsNumber
public OpenBuilder setMyAsNumber(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMyAsNumber
@Deprecated(forRemoval=true) public OpenBuilder setMyAsNumber(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMyAsNumber(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVersion
public OpenBuilder setVersion(ProtocolVersion value)
-
addAugmentation
public OpenBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Open> 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 OpenBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Open>> 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 Open build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Open>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Open,IllegalArgumentException>
-
-