Class MatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Match>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Match,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Match>
Class that buildsMatchBuilder
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:
MatchBuilder createTarget(int fooXyzzy, int barBaz) { return new MatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MatchBuilder, 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:
MatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MatchBuilder()
MatchBuilder(Match base)
MatchBuilder(Match arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MatchBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Match> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>>
E$$augmentation(Class<E$$> augmentationType)
Match
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EthernetMatch
getEthernetMatch()
Icmpv4Match
getIcmpv4Match()
Icmpv6Match
getIcmpv6Match()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId
getInPhyPort()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId
getInPort()
IpMatch
getIpMatch()
Layer3Match
getLayer3Match()
Layer4Match
getLayer4Match()
Metadata
getMetadata()
PacketTypeMatch
getPacketTypeMatch()
ProtocolMatchFields
getProtocolMatchFields()
TcpFlagsMatch
getTcpFlagsMatch()
Tunnel
getTunnel()
VlanMatch
getVlanMatch()
MatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>> augmentationType)
Remove an augmentation from this builder's product.MatchBuilder
setEthernetMatch(EthernetMatch value)
MatchBuilder
setIcmpv4Match(Icmpv4Match value)
MatchBuilder
setIcmpv6Match(Icmpv6Match value)
MatchBuilder
setInPhyPort(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId value)
MatchBuilder
setInPort(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId value)
MatchBuilder
setIpMatch(IpMatch value)
MatchBuilder
setLayer3Match(Layer3Match value)
MatchBuilder
setLayer4Match(Layer4Match value)
MatchBuilder
setMetadata(Metadata value)
MatchBuilder
setPacketTypeMatch(PacketTypeMatch value)
MatchBuilder
setProtocolMatchFields(ProtocolMatchFields value)
MatchBuilder
setTcpFlagsMatch(TcpFlagsMatch value)
MatchBuilder
setTunnel(Tunnel value)
MatchBuilder
setVlanMatch(VlanMatch value)
-
-
-
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.Match
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEthernetMatch
public EthernetMatch getEthernetMatch()
-
getIcmpv4Match
public Icmpv4Match getIcmpv4Match()
-
getIcmpv6Match
public Icmpv6Match getIcmpv6Match()
-
getInPhyPort
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId getInPhyPort()
-
getInPort
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId getInPort()
-
getIpMatch
public IpMatch getIpMatch()
-
getLayer3Match
public Layer3Match getLayer3Match()
-
getLayer4Match
public Layer4Match getLayer4Match()
-
getMetadata
public Metadata getMetadata()
-
getPacketTypeMatch
public PacketTypeMatch getPacketTypeMatch()
-
getProtocolMatchFields
public ProtocolMatchFields getProtocolMatchFields()
-
getTcpFlagsMatch
public TcpFlagsMatch getTcpFlagsMatch()
-
getTunnel
public Tunnel getTunnel()
-
getVlanMatch
public VlanMatch getVlanMatch()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>> E$$ augmentation(Class<E$$> augmentationType)
-
setEthernetMatch
public MatchBuilder setEthernetMatch(EthernetMatch value)
-
setIcmpv4Match
public MatchBuilder setIcmpv4Match(Icmpv4Match value)
-
setIcmpv6Match
public MatchBuilder setIcmpv6Match(Icmpv6Match value)
-
setInPhyPort
public MatchBuilder setInPhyPort(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId value)
-
setInPort
public MatchBuilder setInPort(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorId value)
-
setIpMatch
public MatchBuilder setIpMatch(IpMatch value)
-
setLayer3Match
public MatchBuilder setLayer3Match(Layer3Match value)
-
setLayer4Match
public MatchBuilder setLayer4Match(Layer4Match value)
-
setMetadata
public MatchBuilder setMetadata(Metadata value)
-
setPacketTypeMatch
public MatchBuilder setPacketTypeMatch(PacketTypeMatch value)
-
setProtocolMatchFields
public MatchBuilder setProtocolMatchFields(ProtocolMatchFields value)
-
setTcpFlagsMatch
public MatchBuilder setTcpFlagsMatch(TcpFlagsMatch value)
-
setTunnel
public MatchBuilder setTunnel(Tunnel value)
-
setVlanMatch
public MatchBuilder setVlanMatch(VlanMatch value)
-
addAugmentation
public MatchBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Match> 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 MatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>> 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 Match build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Match>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Match,IllegalArgumentException>
-
-