Class SslErrorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.node.ssl.connection.error.service.rev190723.SslErrorBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SslError>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SslError,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SslErrorBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SslError>
Class that buildsSslErrorBuilder
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:
SslErrorBuilder createTarget(int fooXyzzy, int barBaz) { return new SslErrorBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SslErrorBuilder, 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:
SslErrorBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SslErrorBuilder()
SslErrorBuilder(ErrorMessage arg)
SslErrorBuilder(SslError base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SslErrorBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SslError>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SslError> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.SslErrorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SslError> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SslError>>
E$$augmentation(Class<E$$> augmentationType)
SslError
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getCode()
String
getData()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getNodeIpAddress()
SwitchCertificate
getSwitchCertificate()
SslErrorType
getType()
SslErrorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SslError>> augmentationType)
Remove an augmentation from this builder's product.SslErrorBuilder
setCode(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCode(Uint16)
instead.SslErrorBuilder
setCode(org.opendaylight.yangtools.yang.common.Uint16 value)
SslErrorBuilder
setData(String value)
SslErrorBuilder
setNodeIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
SslErrorBuilder
setSwitchCertificate(SwitchCertificate value)
SslErrorBuilder
setType(SslErrorType value)
-
-
-
Constructor Detail
-
SslErrorBuilder
public SslErrorBuilder()
-
SslErrorBuilder
public SslErrorBuilder(ErrorMessage arg)
-
SslErrorBuilder
public SslErrorBuilder(SslError 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.node.ssl.connection.error.service.rev190723.ErrorMessage
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getCode
public org.opendaylight.yangtools.yang.common.Uint16 getCode()
-
getData
public String getData()
-
getNodeIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNodeIpAddress()
-
getSwitchCertificate
public SwitchCertificate getSwitchCertificate()
-
getType
public SslErrorType getType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SslError>> E$$ augmentation(Class<E$$> augmentationType)
-
setCode
public SslErrorBuilder setCode(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setCode
@Deprecated(forRemoval=true) public SslErrorBuilder setCode(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCode(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setData
public SslErrorBuilder setData(String value)
-
setNodeIpAddress
public SslErrorBuilder setNodeIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
setSwitchCertificate
public SslErrorBuilder setSwitchCertificate(SwitchCertificate value)
-
setType
public SslErrorBuilder setType(SslErrorType value)
-
addAugmentation
public SslErrorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SslError> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public SslErrorBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SslError>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SslError> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public SslErrorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SslError>> 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 SslError build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SslError>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SslError,IllegalArgumentException>
-
-