Class ToRoleBuilder
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.ToRoleBuilder
Class that builds
ToRole
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:
ToRole createToRole(int fooXyzzy, int barBaz) {
return new ToRoleBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ToRole, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedMatchSetOptionsRestrictedGroup
.ToRoleBuilder
(ToRole base) Construct a builder initialized with state from specifiedToRole
.Construct a new builder initialized from specifiedMatchRoleConditionGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ToRole> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ToRole>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ToRole
build()
A newToRole
instance.static @NonNull ToRole
empty()
Get empty instance of ToRole.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
.Return current value associated with the property corresponding toMatchRoleConditionGrouping.getRoleSet()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ToRole>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
to the specified value.setRoleSet
(String value) Set the property corresponding toMatchRoleConditionGrouping.getRoleSet()
to the specified value.
-
Constructor Details
-
ToRoleBuilder
public ToRoleBuilder()Construct an empty builder. -
ToRoleBuilder
Construct a new builder initialized from specifiedMatchRoleConditionGrouping
.- Parameters:
arg
- MatchRoleConditionGrouping from which the builder should be initialized
-
ToRoleBuilder
Construct a new builder initialized from specifiedMatchSetOptionsRestrictedGroup
.- Parameters:
arg
- MatchSetOptionsRestrictedGroup from which the builder should be initialized
-
ToRoleBuilder
Construct a builder initialized with state from specifiedToRole
.- Parameters:
base
- ToRole 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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
empty
Get empty instance of ToRole.- Returns:
- An empty
ToRole
-
getMatchSetOptions
Return current value associated with the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
.- Returns:
- current value
-
getRoleSet
Return current value associated with the property corresponding toMatchRoleConditionGrouping.getRoleSet()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ToRole>> 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
- ifaugmentType
isnull
-
setMatchSetOptions
Set the property corresponding toMatchSetOptionsRestrictedGroup.getMatchSetOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRoleSet
Set the property corresponding toMatchRoleConditionGrouping.getRoleSet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ToRoleBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ToRole> 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 ToRoleBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ToRole>> 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
A newToRole
instance.- Returns:
- A new
ToRole
instance.
-