Package 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

Direct Known Subclasses:

CommandDecoder, EventDecoder

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	Description
final class	AbstractStreamDecoder.BufferedStream	This class avoids locking which gains the performance of this decoder.
static final class	AbstractStreamDecoder.MalformedFrameException
final class	AbstractStreamDecoder.Memento
static final class	AbstractStreamDecoder.Segment
static enum	AbstractStreamDecoder.StreamReadStatus	Underflow - could not completely read out al bytes in one call.

Field Summary

Fields

Modifier and Type	Field	Description
private final ForkNodeArguments	arguments
static final int	BUFFER_SIZE
private static final int	BYTE_LENGTH
private final ReadableByteChannel	channel
private static final byte[]	DEFAULT_STREAM_ENCODING_BYTES
private static final int	DELIMITER_LENGTH
private static final int	INT_LENGTH
private static final String[]	JVM_ERROR_PATTERNS
private final ConsoleLogger	logger
private static final int	LONG_LENGTH
private final Map<AbstractStreamDecoder.Segment,MT>	messageTypes
private static final int	NO_POSITION
private static final String	PRINTABLE_JVM_NATIVE_STREAM

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	checkArguments(AbstractStreamDecoder<M,MT,ST>.Memento memento, int expectedDataElements)
protected final void	checkDelimiter(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected final void	checkHeader(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected void	debugStream(byte[] array, int position, int remaining)
abstract M	decode(AbstractStreamDecoder<M,MT,ST>.Memento memento)
private static int	decodeString(CharsetDecoder decoder, ByteBuffer input, CharBuffer output, int bytesToDecode, boolean endOfInput, int errorStreamFrom)
protected final ForkNodeArguments	getArguments()
protected abstract byte[]	getEncodedMagicNumber()
protected abstract ST[]	nextSegmentType(MT messageType)
private void	printCorruptedStream(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected final void	printRemainingStream(AbstractStreamDecoder<M,MT,ST>.Memento memento)	Print the last string which has not been finished by a new line character.
private AbstractStreamDecoder.StreamReadStatus	read(ByteBuffer buffer, int oldPosition, int recommendedCount)
protected AbstractStreamDecoder.StreamReadStatus	read(AbstractStreamDecoder<M,MT,ST>.Memento memento, int recommendedCount)
protected byte	readByte(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected Charset	readCharset(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected int	readInt(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected Integer	readInteger(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected Long	readLong(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected long	readLongPrivate(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected MT	readMessageType(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected AbstractStreamDecoder.Segment	readSegment(AbstractStreamDecoder<M,MT,ST>.Memento memento)
protected String	readString(AbstractStreamDecoder<M,MT,ST>.Memento memento)
private String	readString(AbstractStreamDecoder<M,MT,ST>.Memento memento, int totalBytes)
protected abstract M	toMessage(MT messageType, AbstractStreamDecoder<M,MT,ST>.Memento memento)
private static String	toString(List<String> strings)

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 Details

BUFFER_SIZE

public static final int BUFFER_SIZE

See Also:

• Constant Field Values

PRINTABLE_JVM_NATIVE_STREAM

private static final String PRINTABLE_JVM_NATIVE_STREAM

See Also:

• Constant Field Values

JVM_ERROR_PATTERNS

private static final String[] JVM_ERROR_PATTERNS

DEFAULT_STREAM_ENCODING_BYTES

private static final byte[] DEFAULT_STREAM_ENCODING_BYTES

NO_POSITION

private static final int NO_POSITION

See Also:

• Constant Field Values

DELIMITER_LENGTH

private static final int DELIMITER_LENGTH

See Also:

• Constant Field Values

BYTE_LENGTH

private static final int BYTE_LENGTH

See Also:

• Constant Field Values

INT_LENGTH

private static final int INT_LENGTH

See Also:

• Constant Field Values

LONG_LENGTH

private static final int LONG_LENGTH

See Also:

• Constant Field Values

channel

private final ReadableByteChannel channel

arguments

private final ForkNodeArguments arguments

messageTypes

private final Map<AbstractStreamDecoder.Segment,MT extends Enum<MT>> messageTypes

logger

private final ConsoleLogger logger

Constructor Details

AbstractStreamDecoder

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

Method Details

decode

public abstract M decode(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.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<M,MT,ST>.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<M,MT,ST>.Memento memento)
                      throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readSegment

@Nonnull
protected AbstractStreamDecoder.Segment readSegment(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
                                             throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readCharset

@Nonnull
protected Charset readCharset(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
                       throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readString

protected String readString(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
                     throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readInteger

protected Integer readInteger(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
                       throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readByte

protected byte readByte(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
                 throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readInt

protected int readInt(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
               throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readLong

protected Long readLong(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
                 throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

readLongPrivate

protected long readLongPrivate(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento)
                        throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

checkDelimiter

protected final void checkDelimiter(AbstractStreamDecoder<M,MT,ST>.Memento memento)
                             throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

checkHeader

protected final void checkHeader(AbstractStreamDecoder<M,MT,ST>.Memento memento)
                          throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

checkArguments

protected void checkArguments(AbstractStreamDecoder<M,MT,ST>.Memento memento,
 int expectedDataElements)
                       throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

readString

private String readString(@Nonnull
 AbstractStreamDecoder<M,MT,ST>.Memento memento,
 @Nonnegative
 int totalBytes)
                   throws IOException,
AbstractStreamDecoder.MalformedFrameException

Throws:

IOException

AbstractStreamDecoder.MalformedFrameException

decodeString

private static int decodeString(@Nonnull
 CharsetDecoder decoder,
 @Nonnull
 ByteBuffer input,
 @Nonnull
 CharBuffer output,
 @Nonnegative
 int bytesToDecode,
 boolean endOfInput,
 @Nonnegative
 int errorStreamFrom)
                         throws AbstractStreamDecoder.MalformedFrameException

Throws:

AbstractStreamDecoder.MalformedFrameException

toString

private static String toString(List<String> strings)

printCorruptedStream

private void printCorruptedStream(AbstractStreamDecoder<M,MT,ST>.Memento memento)

printRemainingStream

protected final void printRemainingStream(AbstractStreamDecoder<M,MT,ST>.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<M,MT,ST>.Memento memento,
 int recommendedCount)
                                               throws IOException

Throws:

IOException

read

private AbstractStreamDecoder.StreamReadStatus read(ByteBuffer buffer,
 int oldPosition,
 int recommendedCount)
                                             throws IOException

Throws:

IOException