Class SfcFlowClassifierBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.flow.classifier.rev160511.sfc.flow.classifiers.attributes.sfc.flow.classifiers.SfcFlowClassifierBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SfcFlowClassifier>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SfcFlowClassifier,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SfcFlowClassifierBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SfcFlowClassifier>
Class that buildsSfcFlowClassifierBuilder
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:
SfcFlowClassifierBuilder createTarget(int fooXyzzy, int barBaz) { return new SfcFlowClassifierBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SfcFlowClassifierBuilder, 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:
SfcFlowClassifierBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SfcFlowClassifierBuilder()
SfcFlowClassifierBuilder(BaseAttributes arg)
SfcFlowClassifierBuilder(IdAttributes arg)
SfcFlowClassifierBuilder(FlowClassifierMatchAttributes arg)
SfcFlowClassifierBuilder(SfcFlowClassifier base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SfcFlowClassifierBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier>>
E$$augmentation(Class<E$$> augmentationType)
SfcFlowClassifier
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getDestinationIpPrefix()
org.opendaylight.yangtools.yang.common.Uint16
getDestinationPortRangeMax()
org.opendaylight.yangtools.yang.common.Uint16
getDestinationPortRangeMin()
Class<? extends EthertypeBase>
getEthertype()
List<L7Parameter>
getL7Parameter()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getLogicalDestinationPort()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getLogicalSourcePort()
String
getName()
String
getProjectId()
Class<? extends ProtocolBase>
getProtocol()
Long
getRevisionNumber()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getSourceIpPrefix()
org.opendaylight.yangtools.yang.common.Uint16
getSourcePortRangeMax()
org.opendaylight.yangtools.yang.common.Uint16
getSourcePortRangeMin()
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()
SfcFlowClassifierKey
key()
SfcFlowClassifierBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier>> augmentationType)
SfcFlowClassifierBuilder
setDestinationIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
SfcFlowClassifierBuilder
setDestinationPortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDestinationPortRangeMax(Uint16)} instead.SfcFlowClassifierBuilder
setDestinationPortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
SfcFlowClassifierBuilder
setDestinationPortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDestinationPortRangeMin(Uint16)} instead.SfcFlowClassifierBuilder
setDestinationPortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
SfcFlowClassifierBuilder
setEthertype(Class<? extends EthertypeBase> value)
SfcFlowClassifierBuilder
setL7Parameter(List<L7Parameter> values)
SfcFlowClassifierBuilder
setLogicalDestinationPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SfcFlowClassifierBuilder
setLogicalSourcePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SfcFlowClassifierBuilder
setName(String value)
SfcFlowClassifierBuilder
setProjectId(String value)
SfcFlowClassifierBuilder
setProtocol(Class<? extends ProtocolBase> value)
SfcFlowClassifierBuilder
setRevisionNumber(Long value)
SfcFlowClassifierBuilder
setSourceIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
SfcFlowClassifierBuilder
setSourcePortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSourcePortRangeMax(Uint16)} instead.SfcFlowClassifierBuilder
setSourcePortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
SfcFlowClassifierBuilder
setSourcePortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSourcePortRangeMin(Uint16)} instead.SfcFlowClassifierBuilder
setSourcePortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
SfcFlowClassifierBuilder
setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SfcFlowClassifierBuilder
setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
SfcFlowClassifierBuilder
withKey(SfcFlowClassifierKey key)
-
-
-
Constructor Detail
-
SfcFlowClassifierBuilder
public SfcFlowClassifierBuilder()
-
SfcFlowClassifierBuilder
public SfcFlowClassifierBuilder(BaseAttributes arg)
-
SfcFlowClassifierBuilder
public SfcFlowClassifierBuilder(IdAttributes arg)
-
SfcFlowClassifierBuilder
public SfcFlowClassifierBuilder(FlowClassifierMatchAttributes arg)
-
SfcFlowClassifierBuilder
public SfcFlowClassifierBuilder(SfcFlowClassifier 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.attrs.rev150712.IdAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.BaseAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.sfc.flow.classifier.rev160511.FlowClassifierMatchAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public SfcFlowClassifierKey key()
-
getDestinationIpPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getDestinationIpPrefix()
-
getDestinationPortRangeMax
public org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMax()
-
getDestinationPortRangeMin
public org.opendaylight.yangtools.yang.common.Uint16 getDestinationPortRangeMin()
-
getEthertype
public Class<? extends EthertypeBase> getEthertype()
-
getL7Parameter
public List<L7Parameter> getL7Parameter()
-
getLogicalDestinationPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getLogicalDestinationPort()
-
getLogicalSourcePort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getLogicalSourcePort()
-
getName
public String getName()
-
getProjectId
public String getProjectId()
-
getProtocol
public Class<? extends ProtocolBase> getProtocol()
-
getRevisionNumber
public Long getRevisionNumber()
-
getSourceIpPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getSourceIpPrefix()
-
getSourcePortRangeMax
public org.opendaylight.yangtools.yang.common.Uint16 getSourcePortRangeMax()
-
getSourcePortRangeMin
public org.opendaylight.yangtools.yang.common.Uint16 getSourcePortRangeMin()
-
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<SfcFlowClassifier>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SfcFlowClassifierBuilder withKey(SfcFlowClassifierKey key)
-
setDestinationIpPrefix
public SfcFlowClassifierBuilder setDestinationIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setDestinationPortRangeMax
public SfcFlowClassifierBuilder setDestinationPortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDestinationPortRangeMax
@Deprecated(forRemoval=true) public SfcFlowClassifierBuilder setDestinationPortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDestinationPortRangeMax(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDestinationPortRangeMin
public SfcFlowClassifierBuilder setDestinationPortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setDestinationPortRangeMin
@Deprecated(forRemoval=true) public SfcFlowClassifierBuilder setDestinationPortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDestinationPortRangeMin(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setEthertype
public SfcFlowClassifierBuilder setEthertype(Class<? extends EthertypeBase> value)
-
setL7Parameter
public SfcFlowClassifierBuilder setL7Parameter(List<L7Parameter> values)
-
setLogicalDestinationPort
public SfcFlowClassifierBuilder setLogicalDestinationPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setLogicalSourcePort
public SfcFlowClassifierBuilder setLogicalSourcePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setName
public SfcFlowClassifierBuilder setName(String value)
-
setProjectId
public SfcFlowClassifierBuilder setProjectId(String value)
-
setProtocol
public SfcFlowClassifierBuilder setProtocol(Class<? extends ProtocolBase> value)
-
setRevisionNumber
public SfcFlowClassifierBuilder setRevisionNumber(Long value)
-
setSourceIpPrefix
public SfcFlowClassifierBuilder setSourceIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setSourcePortRangeMax
public SfcFlowClassifierBuilder setSourcePortRangeMax(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSourcePortRangeMax
@Deprecated(forRemoval=true) public SfcFlowClassifierBuilder setSourcePortRangeMax(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSourcePortRangeMax(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSourcePortRangeMin
public SfcFlowClassifierBuilder setSourcePortRangeMin(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setSourcePortRangeMin
@Deprecated(forRemoval=true) public SfcFlowClassifierBuilder setSourcePortRangeMin(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSourcePortRangeMin(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTenantId
public SfcFlowClassifierBuilder setTenantId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setUuid
public SfcFlowClassifierBuilder setUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public SfcFlowClassifierBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier> augmentationValue)
-
removeAugmentation
public SfcFlowClassifierBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SfcFlowClassifier>> augmentationType)
-
build
public SfcFlowClassifier build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SfcFlowClassifier>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SfcFlowClassifier,IllegalArgumentException>
-
-