Module dev.bitbite.opennetlib

Package dev.bitbite.networking

Class DataPreProcessor

java.lang.Object

dev.bitbite.networking.DataPreProcessor

public class DataPreProcessor
extends java.lang.Object

Keeps track of all DataProcessingLayers and processes data by passing it to each layer and returning its result. Layers will process the data in the order they are registered.

See Also:

DataProcessingLayer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataPreProcessor.TransferMode	The Transfer directions data can travel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataPreProcessor()	Instantiates the DataPreProcessor

Method Summary

Modifier and Type	Method	Description
void	addLayer(DataPreProcessor.TransferMode mode, int index, DataProcessingLayer layer)	Inserts a layer at the specified index.
void	addLayer(DataPreProcessor.TransferMode mode, DataProcessingLayer layer)	Appends a layer at the end of the list
DataProcessingLayer	getLayerAt(DataPreProcessor.TransferMode mode, int index)	Returns a layer of the specified transfermode at a specified position in the list.
java.util.ArrayList<DataProcessingLayer>	getLayers(DataPreProcessor.TransferMode mode)	Returns the list of layers
void	initLayers()	Initializes the DataProcessingLayers
protected byte[]	process(DataPreProcessor.TransferMode mode, byte[] data)	Sends the data to each registered DataProcessingLayer If no DataProcessingLayer is registered, data will stay as it is and returns the processed data
void	removeLayer(DataPreProcessor.TransferMode mode, DataProcessingLayer layer)	Removes a layer from the list
void	shutdown()	Deactivates the DataProcessingLayers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataPreProcessor

protected DataPreProcessor()

Instantiates the DataPreProcessor

Method Detail

process

protected byte[] process(DataPreProcessor.TransferMode mode,
                         byte[] data)

Sends the data to each registered DataProcessingLayer If no DataProcessingLayer is registered, data will stay as it is and returns the processed data

Parameters:

mode - - transfer direction of the data

data - to process

Returns:

processed data

initLayers

public void initLayers()
                throws LayerInitFailedException

Initializes the DataProcessingLayers

Throws:

LayerInitFailedException - if DataProcessingLayer.onEnable() returns false

shutdown

public void shutdown()
              throws LayerDisableFailedException

Deactivates the DataProcessingLayers

Throws:

LayerDisableFailedException - if DataProcessingLayer.onDisable() returns false

addLayer

public void addLayer(DataPreProcessor.TransferMode mode,
                     DataProcessingLayer layer)

Appends a layer at the end of the list

Parameters:

mode - - the transfermode the layer is designed for

layer - - DataProcessingLayer to add

addLayer

public void addLayer(DataPreProcessor.TransferMode mode,
                     int index,
                     DataProcessingLayer layer)

Inserts a layer at the specified index. Shifts the layer currently at that position (if any) and any subsequent layers to the right (adds one to their indices).

Parameters:

mode - - the transfermode the layer is designed for

index - to add the layer at

layer - - DataProcessingLayer to add

getLayerAt

public DataProcessingLayer getLayerAt(DataPreProcessor.TransferMode mode,
                                      int index)

Returns a layer of the specified transfermode at a specified position in the list.

Parameters:

mode - - the transfermode of the layer to get

index - of the layer to get

Returns:

layer - DataProcessingLayer at given index

removeLayer

public void removeLayer(DataPreProcessor.TransferMode mode,
                        DataProcessingLayer layer)

Removes a layer from the list

Parameters:

mode - - the transfermode of the layer to remove

layer - - DataProcessingLayer to remove

getLayers

public java.util.ArrayList<DataProcessingLayer> getLayers(DataPreProcessor.TransferMode mode)

Returns the list of layers

Parameters:

mode - - the transfermode of the layer to remove

Returns:

ArrayList of DataProcessingLayers