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