Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.trunks.rev170118.trunks.attributes.trunks
Class TrunkBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.trunks.rev170118.trunks.attributes.trunks.TrunkBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Trunk>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Trunk,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TrunkBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Trunk>
Class that buildsTrunkBuilder
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:
TrunkBuilder createTarget(int fooXyzzy, int barBaz) { return new TrunkBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TrunkBuilder, 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:
TrunkBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TrunkBuilder()
TrunkBuilder(AdminAttributes arg)
TrunkBuilder(BaseAttributes arg)
TrunkBuilder(IdAttributes arg)
TrunkBuilder(TrunkAttributes arg)
TrunkBuilder(Trunk base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TrunkBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Trunk> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunk>>
E$$augmentation(Class<E$$> augmentationType)
Trunk
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getAdminStateUp()
String
getName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getPortId()
String
getProjectId()
Long
getRevisionNumber()
String
getStatus()
Map<SubPortsKey,SubPorts>
getSubPorts()
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()
Boolean
isAdminStateUp()
Deprecated, for removal: This API element is subject to removal in a future version.TrunkKey
key()
TrunkBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunk>> augmentationType)
Remove an augmentation from this builder's product.TrunkBuilder
setAdminStateUp(Boolean value)
TrunkBuilder
setName(String value)
TrunkBuilder
setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
TrunkBuilder
setProjectId(String value)
TrunkBuilder
setRevisionNumber(Long value)
TrunkBuilder
setStatus(String value)
TrunkBuilder
setSubPorts(List<SubPorts> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSubPorts(Map)
instead.TrunkBuilder
setSubPorts(Map<SubPortsKey,SubPorts> values)
TrunkBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
TrunkBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
TrunkBuilder
withKey(TrunkKey key)
-
-
-
Constructor Detail
-
TrunkBuilder
public TrunkBuilder()
-
TrunkBuilder
public TrunkBuilder(TrunkAttributes arg)
-
TrunkBuilder
public TrunkBuilder(BaseAttributes arg)
-
TrunkBuilder
public TrunkBuilder(IdAttributes arg)
-
TrunkBuilder
public TrunkBuilder(AdminAttributes arg)
-
TrunkBuilder
public TrunkBuilder(Trunk 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.trunks.rev170118.TrunkAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.AdminAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public TrunkKey key()
-
getAdminStateUp
public Boolean getAdminStateUp()
-
isAdminStateUp
@Deprecated(forRemoval=true) public final Boolean isAdminStateUp()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getName
public String getName()
-
getPortId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPortId()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getStatus
public String getStatus()
-
getSubPorts
public Map<SubPortsKey,SubPorts> getSubPorts()
-
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<Trunk>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public TrunkBuilder withKey(TrunkKey key)
-
setAdminStateUp
public TrunkBuilder setAdminStateUp(Boolean value)
-
setName
public TrunkBuilder setName(String value)
-
setPortId
public TrunkBuilder setPortId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setProjectId
public TrunkBuilder setProjectId(String value)
-
setRevisionNumber
public TrunkBuilder setRevisionNumber(Long value)
-
setStatus
public TrunkBuilder setStatus(String value)
-
setSubPorts
public TrunkBuilder setSubPorts(Map<SubPortsKey,SubPorts> values)
-
setSubPorts
@Deprecated(forRemoval=true) public TrunkBuilder setSubPorts(List<SubPorts> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSubPorts(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
-
setTenantId
public TrunkBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public TrunkBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public TrunkBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Trunk> 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 TrunkBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Trunk>> 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 Trunk build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Trunk>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Trunk,IllegalArgumentException>
-
-