Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927

Class SslConnectionErrorBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SslConnectionErrorBuilder

@Generated("mdsal-binding-generator")
public class SslConnectionErrorBuilder
extends Object

Class that builds SslConnectionError 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:

   
     SslConnectionError createSslConnectionError(int fooXyzzy, int barBaz) {
         return new SslConnectionErrorBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of SslConnectionError, 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:

• SslConnectionError

Constructor Summary

Constructors

Constructor	Description
SslConnectionErrorBuilder()	Construct an empty builder.
SslConnectionErrorBuilder(SslConnectionError base)	Construct a builder initialized with state from specified SslConnectionError.

Method Summary

Modifier and Type	Method	Description
SslConnectionErrorBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SslConnectionError> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SslConnectionError>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull SslConnectionError	build()	A new SslConnectionError instance.
String	getInfo()	Return current value associated with the property corresponding to SslConnectionError.getInfo().
SwitchCertificate	getSwitchCertificate()	Return current value associated with the property corresponding to SslConnectionError.getSwitchCertificate().
SslConnectionErrorBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SslConnectionError>> augmentationType)	Remove an augmentation from this builder's product.
SslConnectionErrorBuilder	setInfo(String value)	Set the property corresponding to SslConnectionError.getInfo() to the specified value.
SslConnectionErrorBuilder	setSwitchCertificate(SwitchCertificate value)	Set the property corresponding to SslConnectionError.getSwitchCertificate() to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SslConnectionErrorBuilder

public SslConnectionErrorBuilder()

Construct an empty builder.

SslConnectionErrorBuilder

public SslConnectionErrorBuilder(SslConnectionError base)

Construct a builder initialized with state from specified SslConnectionError.

Parameters:

base - SslConnectionError from which the builder should be initialized

Method Details

getInfo

public String getInfo()

Return current value associated with the property corresponding to SslConnectionError.getInfo().

Returns:

current value

getSwitchCertificate

public SwitchCertificate getSwitchCertificate()

Return current value associated with the property corresponding to SslConnectionError.getSwitchCertificate().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SslConnectionError>>
E$$ augmentation(Class<E$$> augmentationType)

Return the specified augmentation, if it is present in this builder.

Type Parameters:

E$$ - augmentation type

Parameters:

augmentationType - augmentation type class

Returns:

Augmentation object from this builder, or null if not present

Throws:

NullPointerException - if augmentType is null

setInfo

public SslConnectionErrorBuilder setInfo(String value)

Set the property corresponding to SslConnectionError.getInfo() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setSwitchCertificate

public SslConnectionErrorBuilder setSwitchCertificate(SwitchCertificate value)

Set the property corresponding to SslConnectionError.getSwitchCertificate() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public SslConnectionErrorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SslConnectionError> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

public SslConnectionErrorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SslConnectionError>> 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 @NonNull SslConnectionError build()

A new SslConnectionError instance.

Returns:

A new SslConnectionError instance.