Class FromRoleBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.match.role.set.condition.grouping.match.role.set.FromRoleBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FromRole>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FromRole,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FromRoleBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FromRole>
Class that buildsFromRole
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:
FromRole createFromRole(int fooXyzzy, int barBaz) { return new FromRoleBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FromRole, 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:
FromRole
,Builder
-
-
Constructor Summary
Constructors Constructor Description FromRoleBuilder()
FromRoleBuilder(MatchSetOptionsRestrictedGroup arg)
FromRoleBuilder(FromRole base)
FromRoleBuilder(MatchRoleConditionGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FromRoleBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FromRole> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FromRole>>
E$$augmentation(Class<E$$> augmentationType)
FromRole
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MatchSetOptionsRestrictedType
getMatchSetOptions()
String
getRoleSet()
FromRoleBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FromRole>> augmentationType)
Remove an augmentation from this builder's product.FromRoleBuilder
setMatchSetOptions(MatchSetOptionsRestrictedType value)
FromRoleBuilder
setRoleSet(String value)
-
-
-
Constructor Detail
-
FromRoleBuilder
public FromRoleBuilder()
-
FromRoleBuilder
public FromRoleBuilder(MatchRoleConditionGrouping arg)
-
FromRoleBuilder
public FromRoleBuilder(MatchSetOptionsRestrictedGroup arg)
-
FromRoleBuilder
public FromRoleBuilder(FromRole 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:- MatchSetOptionsRestrictedGroup
- MatchRoleConditionGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMatchSetOptions
public MatchSetOptionsRestrictedType getMatchSetOptions()
-
getRoleSet
public String getRoleSet()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FromRole>> E$$ augmentation(Class<E$$> augmentationType)
-
setMatchSetOptions
public FromRoleBuilder setMatchSetOptions(MatchSetOptionsRestrictedType value)
-
setRoleSet
public FromRoleBuilder setRoleSet(String value)
-
addAugmentation
public FromRoleBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FromRole> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public FromRoleBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FromRole>> 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 FromRole build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FromRole>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FromRole,IllegalArgumentException>
-
-