Class SecurityGroupBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.security.groups.attributes.security.groups.SecurityGroupBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SecurityGroup>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SecurityGroup,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SecurityGroupBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SecurityGroup>
Class that buildsSecurityGroupBuilder
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:
SecurityGroupBuilder createTarget(int fooXyzzy, int barBaz) { return new SecurityGroupBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SecurityGroupBuilder, 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:
SecurityGroupBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SecurityGroupBuilder()
SecurityGroupBuilder(BaseAttributes arg)
SecurityGroupBuilder(IdAttributes arg)
SecurityGroupBuilder(SecurityGroup base)
SecurityGroupBuilder(SecurityGroupAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SecurityGroupBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroup> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroup>>
E$$augmentation(Class<E$$> augmentationType)
SecurityGroup
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getName()
String
getProjectId()
Long
getRevisionNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTenantId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getUuid()
SecurityGroupKey
key()
SecurityGroupBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroup>> augmentationType)
Remove an augmentation from this builder's product.SecurityGroupBuilder
setName(String value)
SecurityGroupBuilder
setProjectId(String value)
SecurityGroupBuilder
setRevisionNumber(Long value)
SecurityGroupBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SecurityGroupBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SecurityGroupBuilder
withKey(SecurityGroupKey key)
-
-
-
Constructor Detail
-
SecurityGroupBuilder
public SecurityGroupBuilder()
-
SecurityGroupBuilder
public SecurityGroupBuilder(BaseAttributes arg)
-
SecurityGroupBuilder
public SecurityGroupBuilder(IdAttributes arg)
-
SecurityGroupBuilder
public SecurityGroupBuilder(SecurityGroupAttributes arg)
-
SecurityGroupBuilder
public SecurityGroupBuilder(SecurityGroup 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:- IdAttributes
- BaseAttributes
- SecurityGroupAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public SecurityGroupKey key()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getTenantId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
-
getUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroup>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SecurityGroupBuilder withKey(SecurityGroupKey key)
-
setName
public SecurityGroupBuilder setName(String value)
-
setProjectId
public SecurityGroupBuilder setProjectId(String value)
-
setRevisionNumber
public SecurityGroupBuilder setRevisionNumber(Long value)
-
setTenantId
public SecurityGroupBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public SecurityGroupBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public SecurityGroupBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroup> 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 SecurityGroupBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SecurityGroup>> 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 SecurityGroup build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SecurityGroup>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SecurityGroup,IllegalArgumentException>
-
-