Package com.twilio.voice

Class LogParameters.Builder

java.lang.Object

com.twilio.voice.LogParameters.Builder

Enclosing class:

LogParameters

public static class LogParameters.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	file

Constructor Summary

Constructors

Constructor	Description
Builder(LogLevel level, String tag, String message)	Use this Builder object to create a LogParameters object.

Method Summary

Modifier and Type	Method	Description
LogParameters	build()	Build the LogParameters object
LogParameters.Builder	file(String file)	Set the source filename that generated this log message.
LogParameters.Builder	function(String function)	Set the method name within which this log message was generated.
LogParameters.Builder	line(int line)	Set the line number of the log message in the source file.
LogParameters.Builder	module(LogModule module)	Set the LogModule that generated this log message.
LogParameters.Builder	thread(String thread)	Set the thread name or thread id where the log message is generated.
LogParameters.Builder	throwable(Throwable tr)	Set a throwable object for logging stack traces.
LogParameters.Builder	timestamp(String timestamp)	Set the local timestamp.

Methods inherited from class java.lang.Object

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

Field Details

file

@NonNull
public String file

Constructor Details

Builder

public Builder(@NonNull
 LogLevel level,
 @NonNull
 String tag,
 @NonNull
 String message)

Use this Builder object to create a LogParameters object. Module defaults to LogModule.PLATFORM. File and function parameters default to empty strings and line number defaults to zero. The current time is used as the timestamp parameter and the current thread's name is used as the thread parameter.

Parameters:

level - LogLevel at which this log message was generated. Must not be null.

tag - String tag metadata. Must not be null.

message - Log message text. Must not be null.

Method Details

module

@NonNull
public LogParameters.Builder module(@NonNull
 LogModule module)

Set the LogModule that generated this log message. If not set, LogModule.PLATFORM is used as the default.

Parameters:

module - LogModule. Must not be null.

Returns:

LogParameters.Builder

timestamp

@NonNull
public LogParameters.Builder timestamp(@NonNull
 String timestamp)

Set the local timestamp. If not set, the current timestamp is used as the default.

Parameters:

timestamp - in YY-MM-DD HH:MM:SS.MMM format as a string. Must not be null.

Returns:

LogParameters.Builder

file

@NonNull
public LogParameters.Builder file(@NonNull
 String file)

Set the source filename that generated this log message. If not set, empty string is set as the default.

Parameters:

file - Source filename. Must not be null.

Returns:

LogParameters.Builder

function

@NonNull
public LogParameters.Builder function(@NonNull
 String function)

Set the method name within which this log message was generated. If not set, empty string is set as the default.

Parameters:

function - Method name. Must not be null.

Returns:

LogParameters.Builder

line

public LogParameters.Builder line(int line)

Set the line number of the log message in the source file. If not set, zero is used as the default.

Parameters:

line - Line number

Returns:

LogParameters.Builder

thread

@NonNull
public LogParameters.Builder thread(String thread)

Set the thread name or thread id where the log message is generated. If not set, current thread name or id is used as the default.

Parameters:

thread - Thread name or id. Must not be null.

Returns:

LogParameters.Builder

throwable

@Nullable
public LogParameters.Builder throwable(Throwable tr)

Set a throwable object for logging stack traces. If not set, default is null.

Parameters:

tr - A Throwable object. May be null.

Returns:

LogParameters.Builder

build

@NonNull
public LogParameters build()

Build the LogParameters object

Returns:

LogParameters