Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.acm.rev180214.nacm.rule.list

Class RuleBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.acm.rev180214.nacm.rule.list.RuleBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Rule>, org.opendaylight.yangtools.concepts.CheckedBuilder<Rule,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

@Generated("mdsal-binding-generator")
public class RuleBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Rule>

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

   
     RuleBuilder createTarget(int fooXyzzy, int barBaz) {
         return new RuleBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

RuleBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
RuleBuilder()
RuleBuilder(Rule base)

Method Summary

Modifier and Type	Method	Description
RuleBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Rule> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rule>> E$$	augmentation(Class<E$$> augmentationType)
Rule	build()
Rule.AccessOperations	getAccessOperations()
ActionType	getAction()
String	getComment()
Rule.ModuleName	getModuleName()
String	getName()
RuleType	getRuleType()
RuleKey	key()
RuleBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rule>> augmentationType)	Remove an augmentation from this builder's product.
RuleBuilder	setAccessOperations(Rule.AccessOperations value)
RuleBuilder	setAction(ActionType value)
RuleBuilder	setComment(String value)
RuleBuilder	setModuleName(Rule.ModuleName value)
RuleBuilder	setName(String value)
RuleBuilder	setRuleType(RuleType value)
RuleBuilder	withKey(RuleKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleBuilder

public RuleBuilder()

RuleBuilder

public RuleBuilder(Rule base)

Method Detail

key

public RuleKey key()

getAccessOperations

public Rule.AccessOperations getAccessOperations()

getAction

public ActionType getAction()

getComment

public String getComment()

getModuleName

public Rule.ModuleName getModuleName()

getName

public String getName()

getRuleType

public RuleType getRuleType()

augmentation

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

withKey

public RuleBuilder withKey(RuleKey key)

setAccessOperations

public RuleBuilder setAccessOperations(Rule.AccessOperations value)

setAction

public RuleBuilder setAction(ActionType value)

setComment

public RuleBuilder setComment(String value)

setModuleName

public RuleBuilder setModuleName(Rule.ModuleName value)

setName

public RuleBuilder setName(String value)

setRuleType

public RuleBuilder setRuleType(RuleType value)

addAugmentation

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

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<Rule>

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Rule,IllegalArgumentException>