Class MatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder
-
@Generated("mdsal-binding-generator") public class MatchBuilder extends Object
Class that buildsMatch
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:
Match createMatch(int fooXyzzy, int barBaz) { return new MatchBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Match, 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 opportunities, 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:
Match
- 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
-
-
Constructor Summary
Constructors Constructor Description MatchBuilder()
Construct an empty builder.MatchBuilder(Match base)
Construct a builder initialized with state from specifiedMatch
.MatchBuilder(Match arg)
Construct a new builder initialized from specifiedMatch
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull Match
build()
A newMatch
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EthernetMatch
getEthernetMatch()
Return current value associated with the property corresponding toMatch.getEthernetMatch()
.Icmpv4Match
getIcmpv4Match()
Return current value associated with the property corresponding toMatch.getIcmpv4Match()
.Icmpv6Match
getIcmpv6Match()
Return current value associated with the property corresponding toMatch.getIcmpv6Match()
.NodeConnectorId
getInPhyPort()
Return current value associated with the property corresponding toMatch.getInPhyPort()
.NodeConnectorId
getInPort()
Return current value associated with the property corresponding toMatch.getInPort()
.IpMatch
getIpMatch()
Return current value associated with the property corresponding toMatch.getIpMatch()
.Layer3Match
getLayer3Match()
Return current value associated with the property corresponding toMatch.getLayer3Match()
.Layer4Match
getLayer4Match()
Return current value associated with the property corresponding toMatch.getLayer4Match()
.Metadata
getMetadata()
Return current value associated with the property corresponding toMatch.getMetadata()
.PacketTypeMatch
getPacketTypeMatch()
Return current value associated with the property corresponding toMatch.getPacketTypeMatch()
.ProtocolMatchFields
getProtocolMatchFields()
Return current value associated with the property corresponding toMatch.getProtocolMatchFields()
.TcpFlagsMatch
getTcpFlagsMatch()
Return current value associated with the property corresponding toMatch.getTcpFlagsMatch()
.Tunnel
getTunnel()
Return current value associated with the property corresponding toMatch.getTunnel()
.VlanMatch
getVlanMatch()
Return current value associated with the property corresponding toMatch.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)
Set the property corresponding toMatch.getEthernetMatch()
to the specified value.MatchBuilder
setIcmpv4Match(Icmpv4Match value)
Set the property corresponding toMatch.getIcmpv4Match()
to the specified value.MatchBuilder
setIcmpv6Match(Icmpv6Match value)
Set the property corresponding toMatch.getIcmpv6Match()
to the specified value.MatchBuilder
setInPhyPort(NodeConnectorId value)
Set the property corresponding toMatch.getInPhyPort()
to the specified value.MatchBuilder
setInPort(NodeConnectorId value)
Set the property corresponding toMatch.getInPort()
to the specified value.MatchBuilder
setIpMatch(IpMatch value)
Set the property corresponding toMatch.getIpMatch()
to the specified value.MatchBuilder
setLayer3Match(Layer3Match value)
Set the property corresponding toMatch.getLayer3Match()
to the specified value.MatchBuilder
setLayer4Match(Layer4Match value)
Set the property corresponding toMatch.getLayer4Match()
to the specified value.MatchBuilder
setMetadata(Metadata value)
Set the property corresponding toMatch.getMetadata()
to the specified value.MatchBuilder
setPacketTypeMatch(PacketTypeMatch value)
Set the property corresponding toMatch.getPacketTypeMatch()
to the specified value.MatchBuilder
setProtocolMatchFields(ProtocolMatchFields value)
Set the property corresponding toMatch.getProtocolMatchFields()
to the specified value.MatchBuilder
setTcpFlagsMatch(TcpFlagsMatch value)
Set the property corresponding toMatch.getTcpFlagsMatch()
to the specified value.MatchBuilder
setTunnel(Tunnel value)
Set the property corresponding toMatch.getTunnel()
to the specified value.MatchBuilder
setVlanMatch(VlanMatch value)
Set the property corresponding toMatch.getVlanMatch()
to the specified value.
-
-
-
Constructor Detail
-
MatchBuilder
public MatchBuilder()
Construct an empty builder.
-
MatchBuilder
public MatchBuilder(Match arg)
Construct a new builder initialized from specifiedMatch
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Match from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getEthernetMatch
public EthernetMatch getEthernetMatch()
Return current value associated with the property corresponding toMatch.getEthernetMatch()
.- Returns:
- current value
-
getIcmpv4Match
public Icmpv4Match getIcmpv4Match()
Return current value associated with the property corresponding toMatch.getIcmpv4Match()
.- Returns:
- current value
-
getIcmpv6Match
public Icmpv6Match getIcmpv6Match()
Return current value associated with the property corresponding toMatch.getIcmpv6Match()
.- Returns:
- current value
-
getInPhyPort
public NodeConnectorId getInPhyPort()
Return current value associated with the property corresponding toMatch.getInPhyPort()
.- Returns:
- current value
-
getInPort
public NodeConnectorId getInPort()
Return current value associated with the property corresponding toMatch.getInPort()
.- Returns:
- current value
-
getIpMatch
public IpMatch getIpMatch()
Return current value associated with the property corresponding toMatch.getIpMatch()
.- Returns:
- current value
-
getLayer3Match
public Layer3Match getLayer3Match()
Return current value associated with the property corresponding toMatch.getLayer3Match()
.- Returns:
- current value
-
getLayer4Match
public Layer4Match getLayer4Match()
Return current value associated with the property corresponding toMatch.getLayer4Match()
.- Returns:
- current value
-
getMetadata
public Metadata getMetadata()
Return current value associated with the property corresponding toMatch.getMetadata()
.- Returns:
- current value
-
getPacketTypeMatch
public PacketTypeMatch getPacketTypeMatch()
Return current value associated with the property corresponding toMatch.getPacketTypeMatch()
.- Returns:
- current value
-
getProtocolMatchFields
public ProtocolMatchFields getProtocolMatchFields()
Return current value associated with the property corresponding toMatch.getProtocolMatchFields()
.- Returns:
- current value
-
getTcpFlagsMatch
public TcpFlagsMatch getTcpFlagsMatch()
Return current value associated with the property corresponding toMatch.getTcpFlagsMatch()
.- Returns:
- current value
-
getTunnel
public Tunnel getTunnel()
Return current value associated with the property corresponding toMatch.getTunnel()
.- Returns:
- current value
-
getVlanMatch
public VlanMatch getVlanMatch()
Return current value associated with the property corresponding toMatch.getVlanMatch()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setEthernetMatch
public MatchBuilder setEthernetMatch(EthernetMatch value)
Set the property corresponding toMatch.getEthernetMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIcmpv4Match
public MatchBuilder setIcmpv4Match(Icmpv4Match value)
Set the property corresponding toMatch.getIcmpv4Match()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIcmpv6Match
public MatchBuilder setIcmpv6Match(Icmpv6Match value)
Set the property corresponding toMatch.getIcmpv6Match()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInPhyPort
public MatchBuilder setInPhyPort(NodeConnectorId value)
Set the property corresponding toMatch.getInPhyPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInPort
public MatchBuilder setInPort(NodeConnectorId value)
Set the property corresponding toMatch.getInPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpMatch
public MatchBuilder setIpMatch(IpMatch value)
Set the property corresponding toMatch.getIpMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLayer3Match
public MatchBuilder setLayer3Match(Layer3Match value)
Set the property corresponding toMatch.getLayer3Match()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLayer4Match
public MatchBuilder setLayer4Match(Layer4Match value)
Set the property corresponding toMatch.getLayer4Match()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetadata
public MatchBuilder setMetadata(Metadata value)
Set the property corresponding toMatch.getMetadata()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketTypeMatch
public MatchBuilder setPacketTypeMatch(PacketTypeMatch value)
Set the property corresponding toMatch.getPacketTypeMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtocolMatchFields
public MatchBuilder setProtocolMatchFields(ProtocolMatchFields value)
Set the property corresponding toMatch.getProtocolMatchFields()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTcpFlagsMatch
public MatchBuilder setTcpFlagsMatch(TcpFlagsMatch value)
Set the property corresponding toMatch.getTcpFlagsMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTunnel
public MatchBuilder setTunnel(Tunnel value)
Set the property corresponding toMatch.getTunnel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVlanMatch
public MatchBuilder setVlanMatch(VlanMatch value)
Set the property corresponding toMatch.getVlanMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-