Module ojalgo

Package org.ojalgo.netio

Interface BasicLogger

All Known Implementing Classes:

BasicLogger.BasicWriter, CharacterRing.RingLogger

public interface BasicLogger

BasicLogger is not meant to replace any other logging library. It is primarily used for debugging during development. ojAlgo has zero dependencies, and does not force any specific logging framework on you. But, that meant we had to create something a little better than plain System.out for internal use.

• If you want to redirect whatever ojAlgo outputs then set DEBUG and ERROR to something suitable. BasicLogger.Printer is an interface so it should be possible to create some implementation that wraps your logging system. ojAlgo supplies 3 implementations of that interface.
• ojAlgo typically doesn't do much logging. There's really not much to redirect. The main/only area where BasicLogger is used is for debugging the various optimisation solvers. This is not intended to be "on" in production.
• The logging you need, you do in your code. ojAlgo's main contribution here is to have useful toString() methods.
• If you want to stop any/all possible output from ojAlgo then set DEBUG and ERROR to null.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BasicLogger.BasicWriter
static interface	BasicLogger.Buffer	Temporarily store data/text.
static class	BasicLogger.NotNull
static interface	BasicLogger.Printable
static class	BasicLogger.PrivateDetails

Field Summary

Fields

Modifier and Type	Field	Description
static BasicLogger	DEBUG
static BasicLogger	ERROR
static BasicLogger	NULL

Method Summary

Modifier and Type	Method	Description
java.util.Optional<java.io.Writer>	asWriter()
default void	columns(int width, java.lang.Object... columns)	Will print 1 line/row with the objects in fixed width columns
static void	debug()
static void	debug(int tabs, java.lang.String message, java.lang.Object... arguments)
static void	debug(java.lang.Object message)
static void	debug(java.lang.String message, java.lang.Object... arguments)
static void	debug(java.lang.Throwable throwable, java.lang.String message, java.lang.Object... arguments)
static void	debugColumns(int width, java.lang.Object... columns)
static void	debugFormatted(java.lang.String format, java.lang.Object... args)
static void	debugMatrix(java.lang.String message, Access2D<?> matrix)
static void	debugMatrix(java.lang.String message, Access2D<?> matrix, NumberContext context)
static void	error()
static void	error(int tabs, java.lang.String message, java.lang.Object... arguments)
static void	error(java.lang.Object message)
static void	error(java.lang.String message, java.lang.Object... arguments)
static void	error(java.lang.Throwable throwable, java.lang.String message, java.lang.Object... arguments)
static void	errorColumns(int width, java.lang.Object... columns)
static void	errorFormatted(java.lang.String format, java.lang.Object... args)
static void	errorMatrix(java.lang.String message, Access2D<?> matrix)
static void	errorMatrix(java.lang.String message, Access2D<?> matrix, NumberContext context)
void	print(boolean value)
void	print(byte value)
void	print(char value)
void	print(double value)
void	print(float value)
void	print(int value)
void	print(long value)
void	print(short value)
void	print(java.lang.Object object)
void	print(java.lang.Throwable throwable)
void	printf(java.lang.String format, java.lang.Object... args)
void	println()
default void	println(int tabs, java.lang.String message, java.lang.Object... args)
default void	println(java.lang.Object object)
default void	println(java.lang.String message, java.lang.Object... args)
default void	println(java.lang.Throwable throwable, java.lang.String message, java.lang.Object... args)
default void	printmtrx(java.lang.String message, Access2D<?> matrix)
default void	printmtrx(java.lang.String message, Access2D<?> matrix, NumberContext context)

Field Detail

DEBUG

static final BasicLogger DEBUG

ERROR

static final BasicLogger ERROR

NULL

static final BasicLogger NULL

Method Detail

debug

static void debug()

debug

static void debug(int tabs,
                  java.lang.String message,
                  java.lang.Object... arguments)

debug

static void debug(java.lang.Object message)

debug

static void debug(java.lang.String message,
                  java.lang.Object... arguments)

debug

static void debug(java.lang.Throwable throwable,
                  java.lang.String message,
                  java.lang.Object... arguments)

debugColumns

static void debugColumns(int width,
                         java.lang.Object... columns)

debugFormatted

static void debugFormatted(java.lang.String format,
                           java.lang.Object... args)

debugMatrix

static void debugMatrix(java.lang.String message,
                        Access2D<?> matrix)

debugMatrix

static void debugMatrix(java.lang.String message,
                        Access2D<?> matrix,
                        NumberContext context)

error

static void error()

error

static void error(int tabs,
                  java.lang.String message,
                  java.lang.Object... arguments)

error

static void error(java.lang.Object message)

error

static void error(java.lang.String message,
                  java.lang.Object... arguments)

error

static void error(java.lang.Throwable throwable,
                  java.lang.String message,
                  java.lang.Object... arguments)

errorColumns

static void errorColumns(int width,
                         java.lang.Object... columns)

errorFormatted

static void errorFormatted(java.lang.String format,
                           java.lang.Object... args)

errorMatrix

static void errorMatrix(java.lang.String message,
                        Access2D<?> matrix)

errorMatrix

static void errorMatrix(java.lang.String message,
                        Access2D<?> matrix,
                        NumberContext context)

asWriter

java.util.Optional<java.io.Writer> asWriter()

columns

default void columns(int width,
                     java.lang.Object... columns)

Will print 1 line/row with the objects in fixed width columns

Parameters:

width - The exact witdth of each column

columns - The column objects, #toString() and then fix the length/width

print

void print(boolean value)

print

void print(byte value)

print

void print(char value)

print

void print(double value)

print

void print(float value)

print

void print(int value)

print

void print(long value)

print

void print(java.lang.Object object)

print

void print(short value)

print

void print(java.lang.Throwable throwable)

printf

void printf(java.lang.String format,
            java.lang.Object... args)

println

void println()

println

default void println(int tabs,
                     java.lang.String message,
                     java.lang.Object... args)

println

default void println(java.lang.Object object)

println

default void println(java.lang.String message,
                     java.lang.Object... args)

println

default void println(java.lang.Throwable throwable,
                     java.lang.String message,
                     java.lang.Object... args)

printmtrx

default void printmtrx(java.lang.String message,
                       Access2D<?> matrix)

printmtrx

default void printmtrx(java.lang.String message,
                       Access2D<?> matrix,
                       NumberContext context)