AbstractOxmMatchEntryDeserializer (openflowplugin 0.11.5-SNAPSHOT API)

java.lang.Object
- org.opendaylight.openflowjava.protocol.impl.deserialization.match.AbstractOxmMatchEntryDeserializer

All Implemented Interfaces:

HeaderDeserializer<MatchEntry>, OFGeneralDeserializer

Direct Known Subclasses:

AbstractOxmExperimenterMatchEntryDeserializer, OxmArpOpDeserializer, OxmArpShaDeserializer, OxmArpSpaDeserializer, OxmArpThaDeserializer, OxmArpTpaDeserializer, OxmEthDstDeserializer, OxmEthSrcDeserializer, OxmEthTypeDeserializer, OxmIcmpv4CodeDeserializer, OxmIcmpv4TypeDeserializer, OxmIcmpv6CodeDeserializer, OxmIcmpv6TypeDeserializer, OxmInPhyPortDeserializer, OxmInPortDeserializer, OxmIpDscpDeserializer, OxmIpEcnDeserializer, OxmIpProtoDeserializer, OxmIpv4DstDeserializer, OxmIpv4SrcDeserializer, OxmIpv6DstDeserializer, OxmIpv6ExtHdrDeserializer, OxmIpv6FlabelDeserializer, OxmIpv6NdSllDeserializer, OxmIpv6NdTargetDeserializer, OxmIpv6NdTllDeserializer, OxmIpv6SrcDeserializer, OxmMetadataDeserializer, OxmMplsBosDeserializer, OxmMplsLabelDeserializer, OxmMplsTcDeserializer, OxmPacketTypeDeserializer, OxmPbbIsidDeserializer, OxmSctpDstDeserializer, OxmSctpSrcDeserializer, OxmTcpDstDeserializer, OxmTcpSrcDeserializer, OxmTunnelIdDeserializer, OxmUdpDstDeserializer, OxmUdpSrcDeserializer, OxmVlanPcpDeserializer, OxmVlanVidDeserializer
```
public abstract class AbstractOxmMatchEntryDeserializer
extends Object
implements HeaderDeserializer<MatchEntry>
```
Base class for an Oxm match entry deserializer.

Author:

michal.polkorab

Constructor Summary

Constructors
Constructor Description

AbstractOxmMatchEntryDeserializer()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`MatchEntry`	`deserializeHeader(io.netty.buffer.ByteBuf input)`	Deserializes a byte message headers.
`protected abstract Class<? extends OxmClassBase>`	`getOxmClass()`	Returns the oxm_class class.
`protected abstract Class<? extends MatchField>`	`getOxmField()`	Returns the oxm_field class.
`protected MatchEntryBuilder`	`processHeader(Class<? extends OxmClassBase> oxmClass, Class<? extends MatchField> oxmField, io.netty.buffer.ByteBuf input)`	Prepares match entry header - sets oxm_class, oxm_field, hasMask + sets the buffer.readerIndex() to the end of match entry - where augmentation starts.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractOxmMatchEntryDeserializer
```
public AbstractOxmMatchEntryDeserializer()
```
- Method Detail
  - deserializeHeader
```
public MatchEntry deserializeHeader(io.netty.buffer.ByteBuf input)
```
    Description copied from interface: HeaderDeserializer
    
    Deserializes a byte message headers.
    
    Specified by:
    
    deserializeHeader in interface HeaderDeserializer<MatchEntry>
    
    Parameters:
    
    input - message as bytes in ByteBuf
    
    Returns:
    
    POJO/DTO
  - getOxmField
```
protected abstract Class<? extends MatchField> getOxmField()
```
    Returns the oxm_field class.
  - getOxmClass
```
protected abstract Class<? extends OxmClassBase> getOxmClass()
```
    Returns the oxm_class class.
  - processHeader
```
protected MatchEntryBuilder processHeader(Class<? extends OxmClassBase> oxmClass,
                                          Class<? extends MatchField> oxmField,
                                          io.netty.buffer.ByteBuf input)
```
    Prepares match entry header - sets oxm_class, oxm_field, hasMask + sets the buffer.readerIndex() to the end of match entry - where augmentation starts.
    
    Parameters:
    
    oxmClass - oxm class type
    
    oxmField - oxm field type
    
    input - input bytebuf
    
    Returns:
    
    MatchEntriesBuilder which can be filled with MatchEntry augmentation