Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match
Class TcpMatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TcpMatch>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TcpMatch,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TcpMatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TcpMatch>
Class that buildsTcpMatchBuilder
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:
TcpMatchBuilder createTarget(int fooXyzzy, int barBaz) { return new TcpMatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TcpMatchBuilder, 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:
TcpMatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TcpMatchBuilder()
TcpMatchBuilder(TcpMatch base)
TcpMatchBuilder(TcpMatchFields arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TcpMatchBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch>>
E$$augmentation(Class<E$$> augmentationType)
TcpMatch
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.PortNumber
getTcpDestinationPort()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber
getTcpSourcePort()
TcpMatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch>> augmentationType)
TcpMatchBuilder
setTcpDestinationPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
TcpMatchBuilder
setTcpSourcePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
-
-
Constructor Detail
-
TcpMatchBuilder
public TcpMatchBuilder()
-
TcpMatchBuilder
public TcpMatchBuilder(TcpMatchFields arg)
-
TcpMatchBuilder
public TcpMatchBuilder(TcpMatch 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.TcpMatchFields
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getTcpDestinationPort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getTcpDestinationPort()
-
getTcpSourcePort
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getTcpSourcePort()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch>> E$$ augmentation(Class<E$$> augmentationType)
-
setTcpDestinationPort
public TcpMatchBuilder setTcpDestinationPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
setTcpSourcePort
public TcpMatchBuilder setTcpSourcePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
-
addAugmentation
public TcpMatchBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch> augmentationValue)
-
removeAugmentation
public TcpMatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TcpMatch>> augmentationType)
-
build
public TcpMatch build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TcpMatch>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TcpMatch,IllegalArgumentException>
-
-