Package org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.set.field.match

Class SetFieldMatchBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.set.field.match.SetFieldMatchBuilder

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

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

   
     SetFieldMatch createSetFieldMatch(int fooXyzzy, int barBaz) {
         return new SetFieldMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

SetFieldMatch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SetFieldMatchBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull SetFieldMatch	build()	A new SetFieldMatch instance.
Boolean	getHasMask()	Return current value associated with the property corresponding to SetFieldMatch.getHasMask().
Class<? extends MatchField>	getMatchType()	Return current value associated with the property corresponding to SetFieldMatch.getMatchType().
SetFieldMatchKey	key()	Return current value associated with the property corresponding to SetFieldMatch.key().
SetFieldMatchBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> augmentationType)	Remove an augmentation from this builder's product.
SetFieldMatchBuilder	setHasMask(Boolean value)	Set the property corresponding to SetFieldMatch.getHasMask() to the specified value.
SetFieldMatchBuilder	setMatchType(Class<? extends MatchField> value)	Set the property corresponding to SetFieldMatch.getMatchType() to the specified value.
SetFieldMatchBuilder	withKey(SetFieldMatchKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

SetFieldMatchBuilder

public SetFieldMatchBuilder()

Construct an empty builder.

SetFieldMatchBuilder

public SetFieldMatchBuilder(SetFieldMatch base)

Construct a builder initialized with state from specified SetFieldMatch.

Parameters:

base - SetFieldMatch from which the builder should be initialized

Method Detail

key

public SetFieldMatchKey key()

Return current value associated with the property corresponding to SetFieldMatch.key().

Returns:

current value

getHasMask

public Boolean getHasMask()

Return current value associated with the property corresponding to SetFieldMatch.getHasMask().

Returns:

current value

getMatchType

public Class<? extends MatchField> getMatchType()

Return current value associated with the property corresponding to SetFieldMatch.getMatchType().

Returns:

current value

augmentation

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

withKey

public SetFieldMatchBuilder withKey(SetFieldMatchKey key)

setHasMask

public SetFieldMatchBuilder setHasMask(Boolean value)

Set the property corresponding to SetFieldMatch.getHasMask() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setMatchType

public SetFieldMatchBuilder setMatchType(Class<? extends MatchField> value)

Set the property corresponding to SetFieldMatch.getMatchType() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new SetFieldMatch instance.

Returns:

A new SetFieldMatch instance.