Class IpMatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.IpMatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpMatch>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpMatch,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IpMatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IpMatch>
Class that buildsIpMatchBuilder
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:
IpMatchBuilder createTarget(int fooXyzzy, int barBaz) { return new IpMatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpMatchBuilder, 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:
IpMatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpMatchBuilder()
IpMatchBuilder(IpMatchFields arg)
IpMatchBuilder(IpMatch base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IpMatchBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch>>
E$$augmentation(Class<E$$> augmentationType)
IpMatch
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.Dscp
getIpDscp()
org.opendaylight.yangtools.yang.common.Uint8
getIpEcn()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion
getIpProto()
org.opendaylight.yangtools.yang.common.Uint8
getIpProtocol()
IpMatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch>> augmentationType)
IpMatchBuilder
setIpDscp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp value)
IpMatchBuilder
setIpEcn(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIpEcn(Uint8)} instead.IpMatchBuilder
setIpEcn(org.opendaylight.yangtools.yang.common.Uint8 value)
IpMatchBuilder
setIpProto(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion value)
IpMatchBuilder
setIpProtocol(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIpProtocol(Uint8)} instead.IpMatchBuilder
setIpProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
IpMatchBuilder
public IpMatchBuilder()
-
IpMatchBuilder
public IpMatchBuilder(IpMatchFields arg)
-
IpMatchBuilder
public IpMatchBuilder(IpMatch 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.model.match.types.rev131026.IpMatchFields
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getIpDscp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp getIpDscp()
-
getIpEcn
public org.opendaylight.yangtools.yang.common.Uint8 getIpEcn()
-
getIpProto
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion getIpProto()
-
getIpProtocol
public org.opendaylight.yangtools.yang.common.Uint8 getIpProtocol()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpDscp
public IpMatchBuilder setIpDscp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp value)
-
setIpEcn
public IpMatchBuilder setIpEcn(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIpEcn
@Deprecated(forRemoval=true) public IpMatchBuilder setIpEcn(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIpEcn(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIpProto
public IpMatchBuilder setIpProto(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion value)
-
setIpProtocol
public IpMatchBuilder setIpProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIpProtocol
@Deprecated(forRemoval=true) public IpMatchBuilder setIpProtocol(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIpProtocol(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public IpMatchBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch> augmentationValue)
-
removeAugmentation
public IpMatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpMatch>> augmentationType)
-
build
public IpMatch build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpMatch>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpMatch,IllegalArgumentException>
-
-