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