Package org.apache.logging.log4j.core.layout

Class HtmlLayout.Builder

java.lang.Object

org.apache.logging.log4j.core.layout.HtmlLayout.Builder

All Implemented Interfaces:

Builder<HtmlLayout>

Enclosing class:

HtmlLayout

public static class HtmlLayout.Builder
extends java.lang.Object
implements Builder<HtmlLayout>

Field Summary

Fields

Modifier and Type	Field	Description
private java.nio.charset.Charset	charset
private java.lang.String	contentType
private java.lang.String	datePattern
private java.lang.String	fontName
private HtmlLayout.FontSize	fontSize
private boolean	locationInfo
private java.lang.String	timezone
private java.lang.String	title

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()

Method Summary

Modifier and Type	Method	Description
HtmlLayout	build()	Builds the object after all configuration has been set.
HtmlLayout.Builder	setCharset(java.nio.charset.Charset charset)
HtmlLayout.Builder	setContentType(java.lang.String contentType)
HtmlLayout.Builder	setDatePattern(java.lang.String datePattern)
HtmlLayout.Builder	setFontName(java.lang.String fontName)
HtmlLayout.Builder	setFontSize(HtmlLayout.FontSize fontSize)
HtmlLayout.Builder	setLocationInfo(boolean locationInfo)
HtmlLayout.Builder	setTimezone(java.lang.String timezone)
HtmlLayout.Builder	setTitle(java.lang.String title)
HtmlLayout.Builder	withCharset(java.nio.charset.Charset charset)	Deprecated. since 2.26.0 use setCharset(Charset).
HtmlLayout.Builder	withContentType(java.lang.String contentType)	Deprecated. since 2.26.0 use setContentType(String).
HtmlLayout.Builder	withFontName(java.lang.String fontName)	Deprecated. since 2.26.0 use setFontName(String).
HtmlLayout.Builder	withFontSize(HtmlLayout.FontSize fontSize)	Deprecated. since 2.26.0 use setFontSize(FontSize).
HtmlLayout.Builder	withLocationInfo(boolean locationInfo)	Deprecated. since 2.26.0 use setLocationInfo(boolean).
HtmlLayout.Builder	withTitle(java.lang.String title)	Deprecated. since 2.26.0 use setTitle(String).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

locationInfo

@PluginBuilderAttribute
private boolean locationInfo

title

@PluginBuilderAttribute
private java.lang.String title

contentType

@PluginBuilderAttribute
private java.lang.String contentType

charset

@PluginBuilderAttribute
private java.nio.charset.Charset charset

fontSize

@PluginBuilderAttribute
private HtmlLayout.FontSize fontSize

fontName

@PluginBuilderAttribute
private java.lang.String fontName

datePattern

@PluginBuilderAttribute
private java.lang.String datePattern

timezone

@PluginBuilderAttribute
private java.lang.String timezone

Constructor Detail

Builder

private Builder()

Method Detail

setLocationInfo

public HtmlLayout.Builder setLocationInfo(boolean locationInfo)

Since:

2.26.0

setTitle

public HtmlLayout.Builder setTitle(java.lang.String title)

Since:

2.26.0

setContentType

public HtmlLayout.Builder setContentType(java.lang.String contentType)

Since:

2.26.0

setCharset

public HtmlLayout.Builder setCharset(java.nio.charset.Charset charset)

Since:

2.26.0

setFontSize

public HtmlLayout.Builder setFontSize(HtmlLayout.FontSize fontSize)

Since:

2.26.0

setFontName

public HtmlLayout.Builder setFontName(java.lang.String fontName)

Since:

2.26.0

setDatePattern

public HtmlLayout.Builder setDatePattern(java.lang.String datePattern)

setTimezone

public HtmlLayout.Builder setTimezone(java.lang.String timezone)

withLocationInfo

@Deprecated
public HtmlLayout.Builder withLocationInfo(boolean locationInfo)

Deprecated.

since 2.26.0 use setLocationInfo(boolean).

withTitle

@Deprecated
public HtmlLayout.Builder withTitle(java.lang.String title)

Deprecated.

since 2.26.0 use setTitle(String).

withContentType

@Deprecated
public HtmlLayout.Builder withContentType(java.lang.String contentType)

Deprecated.

since 2.26.0 use setContentType(String).

withCharset

@Deprecated
public HtmlLayout.Builder withCharset(java.nio.charset.Charset charset)

Deprecated.

since 2.26.0 use setCharset(Charset).

withFontSize

@Deprecated
public HtmlLayout.Builder withFontSize(HtmlLayout.FontSize fontSize)

Deprecated.

since 2.26.0 use setFontSize(FontSize).

withFontName

@Deprecated
public HtmlLayout.Builder withFontName(java.lang.String fontName)

Deprecated.

since 2.26.0 use setFontName(String).

build

public HtmlLayout build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<HtmlLayout>

Returns:

the configured instance.