org.apache.maven.surefire.api.stream

Class AbstractStreamDecoder<M,MT extends Enum<MT>,ST extends Enum<ST>>

java.lang.Object

org.apache.maven.surefire.api.stream.AbstractStreamDecoder<M,MT,ST>

Type Parameters:

M - message object

MT - enum describing the meaning of the message

ST - enum for segment type

All Implemented Interfaces:

AutoCloseable

public abstract class AbstractStreamDecoder<M,MT extends Enum<MT>,ST extends Enum<ST>>
extends Object
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractStreamDecoder.BufferedStream This class avoids locking which gains the performance of this decoder.
static class	AbstractStreamDecoder.MalformedFrameException
class	AbstractStreamDecoder.Memento
static class	AbstractStreamDecoder.Segment
static class	AbstractStreamDecoder.StreamReadStatus Underflow - could not completely read out al bytes in one call.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUFFER_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStreamDecoder(ReadableByteChannel channel, ForkNodeArguments arguments, Map<AbstractStreamDecoder.Segment,MT> messageTypes)

Method Summary

Modifier and Type	Method and Description
protected void	checkArguments(AbstractStreamDecoder.Memento memento, int expectedDataElements)
protected void	checkDelimiter(AbstractStreamDecoder.Memento memento)
protected void	checkHeader(AbstractStreamDecoder.Memento memento)
protected void	debugStream(byte[] array, int position, int remaining)
abstract M	decode(AbstractStreamDecoder.Memento memento)
protected ForkNodeArguments	getArguments()
protected abstract byte[]	getEncodedMagicNumber()
protected abstract ST[]	nextSegmentType(MT messageType)
protected void	printRemainingStream(AbstractStreamDecoder.Memento memento) Print the last string which has not been finished by a new line character.
protected AbstractStreamDecoder.StreamReadStatus	read(AbstractStreamDecoder.Memento memento, int recommendedCount)
protected byte	readByte(AbstractStreamDecoder.Memento memento)
protected Charset	readCharset(AbstractStreamDecoder.Memento memento)
protected int	readInt(AbstractStreamDecoder.Memento memento)
protected Integer	readInteger(AbstractStreamDecoder.Memento memento)
protected Long	readLong(AbstractStreamDecoder.Memento memento)
protected long	readLongPrivate(AbstractStreamDecoder.Memento memento)
protected MT	readMessageType(AbstractStreamDecoder.Memento memento)
protected AbstractStreamDecoder.Segment	readSegment(AbstractStreamDecoder.Memento memento)
protected String	readString(AbstractStreamDecoder.Memento memento)
protected abstract M	toMessage(MT messageType, AbstractStreamDecoder.Memento memento)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

AbstractStreamDecoder

protected AbstractStreamDecoder(@Nonnull
                                ReadableByteChannel channel,
                                @Nonnull
                                ForkNodeArguments arguments,
                                @Nonnull
                                Map<AbstractStreamDecoder.Segment,MT> messageTypes)

Method Detail

decode

public abstract M decode(@Nonnull
                         AbstractStreamDecoder.Memento memento)
                  throws MalformedChannelException,
                         IOException

Throws:

MalformedChannelException

IOException

getEncodedMagicNumber

@Nonnull
protected abstract byte[] getEncodedMagicNumber()

nextSegmentType

@Nonnull
protected abstract ST[] nextSegmentType(@Nonnull
                                                  MT messageType)

toMessage

@Nonnull
protected abstract M toMessage(@Nonnull
                                         MT messageType,
                                         @Nonnull
                                         AbstractStreamDecoder.Memento memento)
                                  throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

getArguments

@Nonnull
protected final ForkNodeArguments getArguments()

debugStream

protected void debugStream(byte[] array,
                           int position,
                           int remaining)

readMessageType

protected MT readMessageType(@Nonnull
                             AbstractStreamDecoder.Memento memento)
                      throws IOException,
                             AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readSegment

@Nonnull
protected AbstractStreamDecoder.Segment readSegment(@Nonnull
                                                              AbstractStreamDecoder.Memento memento)
                                                       throws IOException,
                                                              AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readCharset

@Nonnull
protected Charset readCharset(@Nonnull
                                        AbstractStreamDecoder.Memento memento)
                                 throws IOException,
                                        AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readString

protected String readString(@Nonnull
                            AbstractStreamDecoder.Memento memento)
                     throws IOException,
                            AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readInteger

protected Integer readInteger(@Nonnull
                              AbstractStreamDecoder.Memento memento)
                       throws IOException,
                              AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readByte

protected byte readByte(@Nonnull
                        AbstractStreamDecoder.Memento memento)
                 throws IOException,
                        AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readInt

protected int readInt(@Nonnull
                      AbstractStreamDecoder.Memento memento)
               throws IOException,
                      AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readLong

protected Long readLong(@Nonnull
                        AbstractStreamDecoder.Memento memento)
                 throws IOException,
                        AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readLongPrivate

protected long readLongPrivate(@Nonnull
                               AbstractStreamDecoder.Memento memento)
                        throws IOException,
                               AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

checkDelimiter

protected final void checkDelimiter(AbstractStreamDecoder.Memento memento)
                             throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

checkHeader

protected final void checkHeader(AbstractStreamDecoder.Memento memento)
                          throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

checkArguments

protected void checkArguments(AbstractStreamDecoder.Memento memento,
                              int expectedDataElements)
                       throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

printRemainingStream

protected final void printRemainingStream(AbstractStreamDecoder.Memento memento)

Print the last string which has not been finished by a new line character.

Parameters:

memento - current memento object

read

@Nonnull
protected AbstractStreamDecoder.StreamReadStatus read(@Nonnull
                                                                AbstractStreamDecoder.Memento memento,
                                                                int recommendedCount)
                                                         throws IOException

Throws:

IOException