Class RoleRequestInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.RoleRequestInputBuilder
-
@Generated("mdsal-binding-generator") public class RoleRequestInputBuilder extends Object
Class that buildsRoleRequestInput
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:
RoleRequestInput createRoleRequestInput(int fooXyzzy, int barBaz) { return new RoleRequestInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoleRequestInput, 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:
RoleRequestInput
- 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
-
-
Constructor Summary
Constructors Constructor Description RoleRequestInputBuilder()
Construct an empty builder.RoleRequestInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.RoleRequestInputBuilder(RoleRequest$G arg)
Construct a new builder initialized from specifiedRoleRequest$G
.RoleRequestInputBuilder(RoleRequestInput base)
Construct a builder initialized with state from specifiedRoleRequestInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RoleRequestInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RoleRequestInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleRequestInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RoleRequestInput
build()
A newRoleRequestInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getGenerationId()
Return current value associated with the property corresponding toRoleRequest$G.getGenerationId()
.ControllerRole
getRole()
Return current value associated with the property corresponding toRoleRequest$G.getRole()
.org.opendaylight.yangtools.yang.common.Uint8
getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.org.opendaylight.yangtools.yang.common.Uint32
getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.RoleRequestInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleRequestInput>> augmentationType)
Remove an augmentation from this builder's product.RoleRequestInputBuilder
setGenerationId(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toRoleRequest$G.getGenerationId()
to the specified value.RoleRequestInputBuilder
setRole(ControllerRole value)
Set the property corresponding toRoleRequest$G.getRole()
to the specified value.RoleRequestInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.RoleRequestInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
RoleRequestInputBuilder
public RoleRequestInputBuilder()
Construct an empty builder.
-
RoleRequestInputBuilder
public RoleRequestInputBuilder(RoleRequest$G arg)
Construct a new builder initialized from specifiedRoleRequest$G
.- Parameters:
arg
- RoleRequest$G from which the builder should be initialized
-
RoleRequestInputBuilder
public RoleRequestInputBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
RoleRequestInputBuilder
public RoleRequestInputBuilder(RoleRequestInput base)
Construct a builder initialized with state from specifiedRoleRequestInput
.- Parameters:
base
- RoleRequestInput from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getGenerationId
public org.opendaylight.yangtools.yang.common.Uint64 getGenerationId()
Return current value associated with the property corresponding toRoleRequest$G.getGenerationId()
.- Returns:
- current value
-
getRole
public ControllerRole getRole()
Return current value associated with the property corresponding toRoleRequest$G.getRole()
.- Returns:
- current value
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
Return current value associated with the property corresponding toOfHeader.getVersion()
.- Returns:
- current value
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleRequestInput>> 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
-
setGenerationId
public RoleRequestInputBuilder setGenerationId(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toRoleRequest$G.getGenerationId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRole
public RoleRequestInputBuilder setRole(ControllerRole value)
Set the property corresponding toRoleRequest$G.getRole()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public RoleRequestInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
public RoleRequestInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RoleRequestInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RoleRequestInput> 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 RoleRequestInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoleRequestInput>> 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 RoleRequestInput build()
A newRoleRequestInput
instance.- Returns:
- A new
RoleRequestInput
instance.
-
-