Package org.apache.maven.surefire.api.stream

Class AbstractStreamEncoder<E extends Enum<E>>

java.lang.Object

org.apache.maven.surefire.api.stream.AbstractStreamEncoder<E>

Type Parameters:

E - type of the message

Direct Known Subclasses:

CommandEncoder, EventEncoder

public abstract class AbstractStreamEncoder<E extends Enum<E>>
extends Object

The base class of stream encoder. The type of message is expressed by opcode where the opcode object is described by the generic type AbstractStreamEncoder.

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte	BOOLEAN_NON_NULL_OBJECT
private static final byte	BOOLEAN_NULL_OBJECT
private static final byte[]	INT_BINARY
private final WritableByteChannel	out

Constructor Summary

Constructors

Constructor	Description
AbstractStreamEncoder(WritableByteChannel out)

Method Summary

Modifier and Type	Method	Description
void	encode(CharsetEncoder encoder, ByteBuffer result, E operation, String... messages)
void	encode(CharsetEncoder encoder, ByteBuffer result, E operation, RunMode runMode, Long testRunId, String... messages)
void	encodeCharset(ByteBuffer result)
void	encodeHeader(ByteBuffer result, E operation)
void	encodeHeader(ByteBuffer result, E operation, RunMode runMode, Long testRunId)
void	encodeInteger(ByteBuffer result, Integer i)
void	encodeString(CharsetEncoder encoder, ByteBuffer result, String string)
private void	encodeStringData(ByteBuffer result, CharsetEncoder encoder, String... messages)
protected abstract byte[]	enumToByteArray(E e)
int	estimateBufferLength(int opcodeLength, RunMode runMode, CharsetEncoder encoder, int integersCounter, int longsCounter, String... strings)
protected abstract Charset	getCharset()
protected abstract byte[]	getEncodedCharsetName()
protected abstract byte[]	getEncodedMagicNumber()
protected abstract CharsetEncoder	newCharsetEncoder()
private static String	nonNull(String msg)
protected void	write(ByteBuffer frame, boolean sendImmediately)

Methods inherited from class java.lang.Object

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

Field Details

BOOLEAN_NON_NULL_OBJECT

private static final byte BOOLEAN_NON_NULL_OBJECT

See Also:

• Constant Field Values

BOOLEAN_NULL_OBJECT

private static final byte BOOLEAN_NULL_OBJECT

See Also:

• Constant Field Values

INT_BINARY

private static final byte[] INT_BINARY

out

private final WritableByteChannel out

Constructor Details

AbstractStreamEncoder

public AbstractStreamEncoder(WritableByteChannel out)

Method Details

getEncodedMagicNumber

@Nonnull
protected abstract byte[] getEncodedMagicNumber()

enumToByteArray

@Nonnull
protected abstract byte[] enumToByteArray(E e)

getEncodedCharsetName

@Nonnull
protected abstract byte[] getEncodedCharsetName()

getCharset

@Nonnull
protected abstract Charset getCharset()

newCharsetEncoder

@Nonnull
protected abstract CharsetEncoder newCharsetEncoder()

write

protected void write(ByteBuffer frame,
 boolean sendImmediately)
              throws IOException

Throws:

IOException

encodeHeader

public void encodeHeader(ByteBuffer result,
 E operation,
 RunMode runMode,
 Long testRunId)

encodeHeader

public void encodeHeader(ByteBuffer result,
 E operation)

encodeCharset

public void encodeCharset(ByteBuffer result)

encodeString

public void encodeString(CharsetEncoder encoder,
 ByteBuffer result,
 String string)

encodeInteger

public void encodeInteger(ByteBuffer result,
 Integer i)

encode

public void encode(CharsetEncoder encoder,
 ByteBuffer result,
 E operation,
 RunMode runMode,
 Long testRunId,
 String... messages)

encode

public void encode(CharsetEncoder encoder,
 ByteBuffer result,
 E operation,
 String... messages)

encodeStringData

private void encodeStringData(ByteBuffer result,
 CharsetEncoder encoder,
 String... messages)

estimateBufferLength

public int estimateBufferLength(int opcodeLength,
 RunMode runMode,
 CharsetEncoder encoder,
 int integersCounter,
 int longsCounter,
 String... strings)

nonNull

private static String nonNull(String msg)