org.rvpf.base.pipe

Class PipeRequest

Object

PipeRequest

Direct Known Subclasses:

PipeEngineRequest, PipeSinkRequest

@Immutable
public abstract class PipeRequest
extends Object

Pipe request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipeRequest.LogLevel Log level.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEBUG_LEVEL Debug level.
static String	ERROR_LEVEL Error level.
static String	FATAL_LEVEL Fatal level.
static String	INFO_LEVEL Info level.
static String	LINE_SEPARATOR Line separator.
static Pattern	SPACE_PATTERN Space pattern.
static String	TRACE_LEVEL Trace level.
static String	WARN_LEVEL Warn level.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PipeRequest(String requestID, int version) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
static String	cleanString(String string) Cleans a string by replacing control chars with spaces.
static void	debug(Messages.Entry entry, Object... params) Logs a message at the DEBUG level.
static void	debug(String format, Object... params) Logs a message at the DEBUG level.
static RuntimeException	error(Messages.Entry entry, Object... params) Logs a message at the ERROR level.
static RuntimeException	error(String format, Object... params) Logs a message at the ERROR level.
static RuntimeException	fatal(Messages.Entry entry, Object... params) Logs a message at the FATAL level.
static RuntimeException	fatal(String format, Object... params) Logs a message at the FATAL level.
protected static Optional<String>	firstLine() Returns the first line for a request.
String	getRequestID() Gets the request ID.
int	getVersion() Gets the version.
static void	info(Messages.Entry entry, Object... params) Logs a message at the INFO level.
static void	info(String format, Object... params) Logs a message at the INFO level.
static void	log(PipeRequest.LogLevel level, Messages.Entry entry, Object... params) Logs a message at the specified level.
static void	log(PipeRequest.LogLevel level, String format, Object... params) Logs a message at the specified level.
protected static String	nextLine() Returns the next line for a request.
protected static PointValue	nextPointValue(boolean stampRequired) Returns the point value from the next input line.
protected static int	parseInt(String text) Parses an int.
static String	pointValueToString(PointValue pointValue) Converts a point value to a string.
static PointValue	stringToPointValue(String string) Converts a string to a point value.
static void	trace(Messages.Entry entry, Object... params) Logs a message at the TRACE level.
static void	trace(String format, Object... params) Logs a message at the TRACE level.
static void	warn(Messages.Entry entry, Object... params) Logs a message at the WARN level.
static void	warn(String format, Object... params) Logs a message at the WARN level.
protected static void	writeLine(String line) Writes a line.
protected static void	writePointValue(PointValue pointValue) Writes a point value.

Methods inherited from class Object

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

Field Detail

DEBUG_LEVEL

public static final String DEBUG_LEVEL

Debug level.

See Also:

Constant Field Values

ERROR_LEVEL

public static final String ERROR_LEVEL

Error level.

See Also:

Constant Field Values

FATAL_LEVEL

public static final String FATAL_LEVEL

Fatal level.

See Also:

Constant Field Values

INFO_LEVEL

public static final String INFO_LEVEL

Info level.

See Also:

Constant Field Values

LINE_SEPARATOR

public static final String LINE_SEPARATOR

Line separator.

SPACE_PATTERN

public static final Pattern SPACE_PATTERN

Space pattern.

TRACE_LEVEL

public static final String TRACE_LEVEL

Trace level.

See Also:

Constant Field Values

WARN_LEVEL

public static final String WARN_LEVEL

Warn level.

See Also:

Constant Field Values

Constructor Detail

PipeRequest

protected PipeRequest(@Nonnull
                      String requestID,
                      int version)

Constructs an instance.

Parameters:

requestID - The request ID.

version - The request format version.

Method Detail

cleanString

@Nonnull
 @CheckReturnValue
public static String cleanString(@Nonnull
                                                               String string)

Cleans a string by replacing control chars with spaces.

Parameters:

string - The string to clean.

Returns:

The clean string.

debug

public static void debug(@Nonnull
                         Messages.Entry entry,
                         @Nonnull
                         Object... params)

Logs a message at the DEBUG level.

Parameters:

entry - The messages entry.

params - The message parameters.

debug

public static void debug(@Nonnull
                         String format,
                         @Nonnull
                         Object... params)

Logs a message at the DEBUG level.

Parameters:

format - The message format.

params - The message parameters.

error

@Nonnull
 @CheckReturnValue
public static RuntimeException error(@Nonnull
                                                                   Messages.Entry entry,
                                                                   @Nonnull
                                                                   Object... params)

Logs a message at the ERROR level.

Parameters:

entry - The messages entry.

params - The message parameters.

Returns:

A runtime exception.

error

@Nonnull
 @CheckReturnValue
public static RuntimeException error(@Nonnull
                                                                   String format,
                                                                   @Nonnull
                                                                   Object... params)

Logs a message at the ERROR level.

Parameters:

format - The message format.

params - The message parameters.

Returns:

A runtime exception.

fatal

@Nonnull
 @CheckReturnValue
public static RuntimeException fatal(@Nonnull
                                                                   Messages.Entry entry,
                                                                   @Nonnull
                                                                   Object... params)

Logs a message at the FATAL level.

Parameters:

entry - The messages entry.

params - The message parameters.

Returns:

A runtime exception.

fatal

@Nonnull
 @CheckReturnValue
public static RuntimeException fatal(@Nonnull
                                                                   String format,
                                                                   @Nonnull
                                                                   Object... params)

Logs a message at the FATAL level.

Parameters:

format - The message format.

params - The message parameters.

Returns:

A runtime exception.

info

public static void info(@Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a message at the INFO level.

Parameters:

entry - The messages entry.

params - The message parameters.

info

public static void info(@Nonnull
                        String format,
                        @Nonnull
                        Object... params)

Logs a message at the INFO level.

Parameters:

format - The message format.

params - The message parameters.

log

public static void log(@Nonnull
                       PipeRequest.LogLevel level,
                       @Nonnull
                       Messages.Entry entry,
                       @Nonnull
                       Object... params)

Logs a message at the specified level.

Parameters:

level - The log level.

entry - The messages entry.

params - The message parameters.

log

public static void log(@Nonnull
                       PipeRequest.LogLevel level,
                       @Nonnull
                       String format,
                       @Nonnull
                       Object... params)

Logs a message at the specified level.

Parameters:

level - The log level.

format - The message format.

params - The message parameters.

pointValueToString

@Nonnull
 @CheckReturnValue
public static String pointValueToString(@Nonnull
                                                                      PointValue pointValue)

Converts a point value to a string.

Parameters:

pointValue - The point value.

Returns:

The string.

stringToPointValue

@Nullable
 @CheckReturnValue
public static PointValue stringToPointValue(@Nonnull
                                                                           String string)

Converts a string to a point value.

Parameters:

string - The string.

Returns:

The point value (null on failure).

trace

public static void trace(@Nonnull
                         Messages.Entry entry,
                         @Nonnull
                         Object... params)

Logs a message at the TRACE level.

Parameters:

entry - The messages entry.

params - The message parameters.

trace

public static void trace(@Nonnull
                         String format,
                         @Nonnull
                         Object... params)

Logs a message at the TRACE level.

Parameters:

format - The message format.

params - The message parameters.

warn

public static void warn(@Nonnull
                        Messages.Entry entry,
                        @Nonnull
                        Object... params)

Logs a message at the WARN level.

Parameters:

entry - The messages entry.

params - The message parameters.

warn

public static void warn(@Nonnull
                        String format,
                        @Nonnull
                        Object... params)

Logs a message at the WARN level.

Parameters:

format - The message format.

params - The message parameters.

getRequestID

@Nonnull
 @CheckReturnValue
public final String getRequestID()

Gets the request ID.

Returns:

The request ID.

getVersion

@Nonnull
 @CheckReturnValue
public final int getVersion()

Gets the version.

Returns:

The version.

firstLine

@Nonnull
 @CheckReturnValue
protected static Optional<String> firstLine()

Returns the first line for a request.

Drops lines containing only whitespace characters. Also recognizes synchronization requests and responds.

Returns:

The first request line (empty on end of input).

nextLine

@Nonnull
 @CheckReturnValue
protected static String nextLine()

Returns the next line for a request.

Drops lines containing only whitespace characters.

Returns:

The first request line (throws a RuntimeException if none).

nextPointValue

@Nonnull
 @CheckReturnValue
protected static PointValue nextPointValue(boolean stampRequired)

Returns the point value from the next input line.

Parameters:

stampRequired - True if a stamp is required.

Returns:

The point value.

parseInt

@CheckReturnValue
protected static int parseInt(@Nonnull
                                                 String text)

Parses an int.

Parameters:

text - The text representation.

Returns:

The int.

writeLine

protected static void writeLine(@Nonnull
                                String line)

Writes a line.

Parameters:

line - The line.

writePointValue

protected static void writePointValue(@Nonnull
                                      PointValue pointValue)

Writes a point value.

Parameters:

pointValue - The point value.