Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.source.as._4.extended.community._case

Class SourceAs4ExtendedCommunityBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.source.as._4.extended.community._case.SourceAs4ExtendedCommunityBuilder

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

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

   
     SourceAs4ExtendedCommunity createSourceAs4ExtendedCommunity(int fooXyzzy, int barBaz) {
         return new SourceAs4ExtendedCommunityBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• SourceAs4ExtendedCommunity

Constructor Summary

Constructors

Constructor	Description
SourceAs4ExtendedCommunityBuilder()	Construct an empty builder.
SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunity base)	Construct a builder initialized with state from specified SourceAs4ExtendedCommunity.
SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunityGrouping arg)	Construct a new builder initialized from specified SourceAs4ExtendedCommunityGrouping.

Method Summary

Modifier and Type	Method	Description
SourceAs4ExtendedCommunityBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull SourceAs4ExtendedCommunity	build()	A new SourceAs4ExtendedCommunity instance.
static @NonNull SourceAs4ExtendedCommunity	empty()	Get empty instance of SourceAs4ExtendedCommunity.
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.AsNumber	getGlobalAdministrator()	Return current value associated with the property corresponding to SourceAs4ExtendedCommunityGrouping.getGlobalAdministrator().
SourceAs4ExtendedCommunityBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>> augmentationType)	Remove an augmentation from this builder's product.
SourceAs4ExtendedCommunityBuilder	setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)	Set the property corresponding to SourceAs4ExtendedCommunityGrouping.getGlobalAdministrator() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

SourceAs4ExtendedCommunityBuilder

public SourceAs4ExtendedCommunityBuilder()

Construct an empty builder.

SourceAs4ExtendedCommunityBuilder

public SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunityGrouping arg)

Construct a new builder initialized from specified SourceAs4ExtendedCommunityGrouping.

Parameters:

arg - SourceAs4ExtendedCommunityGrouping from which the builder should be initialized

SourceAs4ExtendedCommunityBuilder

public SourceAs4ExtendedCommunityBuilder(SourceAs4ExtendedCommunity base)

Construct a builder initialized with state from specified SourceAs4ExtendedCommunity.

Parameters:

base - SourceAs4ExtendedCommunity from which the builder should be initialized

Method Details

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:

• SourceAs4ExtendedCommunityGrouping

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

empty

public static @NonNull SourceAs4ExtendedCommunity empty()

Get empty instance of SourceAs4ExtendedCommunity.

Returns:

An empty SourceAs4ExtendedCommunity

getGlobalAdministrator

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getGlobalAdministrator()

Return current value associated with the property corresponding to SourceAs4ExtendedCommunityGrouping.getGlobalAdministrator().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>>
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

setGlobalAdministrator

public SourceAs4ExtendedCommunityBuilder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)

Set the property corresponding to SourceAs4ExtendedCommunityGrouping.getGlobalAdministrator() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public SourceAs4ExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity> 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 SourceAs4ExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceAs4ExtendedCommunity>> 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 SourceAs4ExtendedCommunity build()

A new SourceAs4ExtendedCommunity instance.

Returns:

A new SourceAs4ExtendedCommunity instance.