Class TapFlowBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.tapaas.rev171024.tap.service.attributes.tap.flows.TapFlowBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TapFlow>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TapFlow,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TapFlowBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TapFlow>
Class that buildsTapFlowBuilder
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:
TapFlowBuilder createTarget(int fooXyzzy, int barBaz) { return new TapFlowBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TapFlowBuilder, 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:
TapFlowBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TapFlowBuilder()
TapFlowBuilder(BaseAttributes arg)
TapFlowBuilder(IdAttributes arg)
TapFlowBuilder(TapFlow base)
TapFlowBuilder(TapFlowAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TapFlowBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TapFlow> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TapFlow>>
E$$augmentation(Class<E$$> augmentationType)
TapFlow
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends DirectionBase>
getDirection()
String
getName()
String
getProjectId()
Long
getRevisionNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getSourcePort()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getTapServiceId()
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()
TapFlowKey
key()
TapFlowBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TapFlow>> augmentationType)
Remove an augmentation from this builder's product.TapFlowBuilder
setDirection(Class<? extends DirectionBase> value)
TapFlowBuilder
setName(String value)
TapFlowBuilder
setProjectId(String value)
TapFlowBuilder
setRevisionNumber(Long value)
TapFlowBuilder
setSourcePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
TapFlowBuilder
setTapServiceId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
TapFlowBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
TapFlowBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
TapFlowBuilder
withKey(TapFlowKey key)
-
-
-
Constructor Detail
-
TapFlowBuilder
public TapFlowBuilder()
-
TapFlowBuilder
public TapFlowBuilder(BaseAttributes arg)
-
TapFlowBuilder
public TapFlowBuilder(IdAttributes arg)
-
TapFlowBuilder
public TapFlowBuilder(TapFlowAttributes arg)
-
TapFlowBuilder
public TapFlowBuilder(TapFlow 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.tapaas.rev171024.TapFlowAttributes
- 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 TapFlowKey key()
-
getDirection
public Class<? extends DirectionBase> getDirection()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getRevisionNumber
public Long getRevisionNumber()
-
getSourcePort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSourcePort()
-
getTapServiceId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTapServiceId()
-
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<TapFlow>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public TapFlowBuilder withKey(TapFlowKey key)
-
setDirection
public TapFlowBuilder setDirection(Class<? extends DirectionBase> value)
-
setName
public TapFlowBuilder setName(String value)
-
setProjectId
public TapFlowBuilder setProjectId(String value)
-
setRevisionNumber
public TapFlowBuilder setRevisionNumber(Long value)
-
setSourcePort
public TapFlowBuilder setSourcePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setTapServiceId
public TapFlowBuilder setTapServiceId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setTenantId
public TapFlowBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public TapFlowBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public TapFlowBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TapFlow> 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 TapFlowBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TapFlow>> 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 TapFlow build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TapFlow>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TapFlow,IllegalArgumentException>
-
-