Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes
Class SecurityGroupsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.SecurityGroupsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SecurityGroups>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SecurityGroups,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SecurityGroupsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SecurityGroups>
Class that buildsSecurityGroupsBuilder
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:
SecurityGroupsBuilder createTarget(int fooXyzzy, int barBaz) { return new SecurityGroupsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SecurityGroupsBuilder, 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:
SecurityGroupsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SecurityGroupsBuilder()
SecurityGroupsBuilder(SecurityGroups base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SecurityGroupsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroups> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroups>>
E$$augmentation(Class<E$$> augmentationType)
SecurityGroups
build()
Map<SecurityGroupKey,SecurityGroup>
getSecurityGroup()
SecurityGroupsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroups>> augmentationType)
Remove an augmentation from this builder's product.SecurityGroupsBuilder
setSecurityGroup(List<SecurityGroup> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSecurityGroup(Map)
instead.SecurityGroupsBuilder
setSecurityGroup(Map<SecurityGroupKey,SecurityGroup> values)
-
-
-
Constructor Detail
-
SecurityGroupsBuilder
public SecurityGroupsBuilder()
-
SecurityGroupsBuilder
public SecurityGroupsBuilder(SecurityGroups base)
-
-
Method Detail
-
getSecurityGroup
public Map<SecurityGroupKey,SecurityGroup> getSecurityGroup()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroups>> E$$ augmentation(Class<E$$> augmentationType)
-
setSecurityGroup
public SecurityGroupsBuilder setSecurityGroup(Map<SecurityGroupKey,SecurityGroup> values)
-
setSecurityGroup
@Deprecated(forRemoval=true) public SecurityGroupsBuilder setSecurityGroup(List<SecurityGroup> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSecurityGroup(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public SecurityGroupsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroups> 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 SecurityGroupsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroups>> 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 SecurityGroups build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SecurityGroups>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SecurityGroups,IllegalArgumentException>
-
-