Apache Log4cxx  Version 1.2.0
Loading...
Searching...
No Matches
log4cxx::pattern::FormattingInfo Class Reference

Modifies the output of a pattern converter for a specified minimum and maximum width and alignment. More...

#include <formattinginfo.h>

Inheritance diagram for log4cxx::pattern::FormattingInfo:
log4cxx::helpers::Object

Public Member Functions

 FormattingInfo (const bool leftAlign, const int minLength, const int maxLength)
 Creates new instance.
 
 ~FormattingInfo ()
 
bool isLeftAligned () const
 Determine if left aligned.
 
int getMinLength () const
 Get minimum length.
 
int getMaxLength () const
 Get maximum length.
 
void format (const int fieldStart, LogString &buffer) const
 Adjust the content of the buffer based on the specified lengths and alignment.
 
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
 
virtual const helpers::ClassgetClass () const =0
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 

Static Public Member Functions

static FormattingInfoPtr getDefault ()
 Gets default instance.
 

Detailed Description

Modifies the output of a pattern converter for a specified minimum and maximum width and alignment.

Constructor & Destructor Documentation

◆ FormattingInfo()

log4cxx::pattern::FormattingInfo::FormattingInfo ( const bool  leftAlign,
const int  minLength,
const int  maxLength 
)

Creates new instance.

Parameters
leftAlignleft align if true.
minLengthminimum length.
maxLengthmaximum length.

◆ ~FormattingInfo()

log4cxx::pattern::FormattingInfo::~FormattingInfo ( )

Member Function Documentation

◆ format()

void log4cxx::pattern::FormattingInfo::format ( const int  fieldStart,
LogString buffer 
) const

Adjust the content of the buffer based on the specified lengths and alignment.

Parameters
fieldStartstart of field in buffer.
bufferbuffer to be modified.

◆ getDefault()

static FormattingInfoPtr log4cxx::pattern::FormattingInfo::getDefault ( )
static

Gets default instance.

Returns
default instance.

◆ getMaxLength()

int log4cxx::pattern::FormattingInfo::getMaxLength ( ) const

Get maximum length.

Returns
maximum length.

◆ getMinLength()

int log4cxx::pattern::FormattingInfo::getMinLength ( ) const

Get minimum length.

Returns
minimum length.

◆ isLeftAligned()

bool log4cxx::pattern::FormattingInfo::isLeftAligned ( ) const

Determine if left aligned.

Returns
true if left aligned.

The documentation for this class was generated from the following file: