Class RoleSetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.role.set.RoleSetBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RoleSet>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RoleSet,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RoleSetBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<RoleSet>
Class that buildsRoleSetBuilder
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:
RoleSetBuilder createTarget(int fooXyzzy, int barBaz) { return new RoleSetBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoleSetBuilder, 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:
RoleSetBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RoleSetBuilder()
RoleSetBuilder(RoleSet base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RoleSetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RoleSet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleSet>>
E$$augmentation(Class<E$$> augmentationType)
RoleSet
build()
List<PeerRole>
getRole()
String
getRoleSetName()
RoleSetKey
key()
RoleSetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleSet>> augmentationType)
Remove an augmentation from this builder's product.RoleSetBuilder
setRole(List<PeerRole> values)
RoleSetBuilder
setRoleSetName(String value)
RoleSetBuilder
withKey(RoleSetKey key)
-
-
-
Constructor Detail
-
RoleSetBuilder
public RoleSetBuilder()
-
RoleSetBuilder
public RoleSetBuilder(RoleSet base)
-
-
Method Detail
-
key
public RoleSetKey key()
-
getRoleSetName
public String getRoleSetName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleSet>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public RoleSetBuilder withKey(RoleSetKey key)
-
setRole
public RoleSetBuilder setRole(List<PeerRole> values)
-
setRoleSetName
public RoleSetBuilder setRoleSetName(String value)
-
addAugmentation
public RoleSetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RoleSet> 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 RoleSetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleSet>> 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 RoleSet build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RoleSet>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RoleSet,IllegalArgumentException>
-
-