net.openhft.chronicle.wire.utils

Class SourceCodeFormatter

java.lang.Object

net.openhft.chronicle.wire.utils.SourceCodeFormatter

All Implemented Interfaces:

Appendable, CharSequence

Direct Known Subclasses:

JavaSourceCodeFormatter, JsonSourceCodeFormatter

public class SourceCodeFormatter
extends Object
implements Appendable, CharSequence

Represents a simple Java source code formatter. The formatter aims to enhance code readability by managing indentation for block-level code scopes. It increases the indent on encountering a '{' and decreases on a '}'. All trailing spaces before a newline character are removed to maintain a consistent format.

Constructor Summary

Constructors

Constructor and Description
SourceCodeFormatter(int indentSpaces) Constructor to initialize the formatter with given indent spaces and sets the default indentation count to 0.
SourceCodeFormatter(int indentSpaces, AtomicInteger indent) Constructor to initialize the formatter with given indent spaces and an atomic integer value.
SourceCodeFormatter(int indentSpaces, int i) Constructor to initialize the formatter with given indent spaces and a specific integer value.

Method Summary

Modifier and Type	Method and Description
SourceCodeFormatter	append(boolean flag) Appends the provided boolean value to the formatted string.
SourceCodeFormatter	append(char c)
SourceCodeFormatter	append(CharSequence csq)
SourceCodeFormatter	append(CharSequence csq, int start, int end)
SourceCodeFormatter	append(double d) Appends the provided double value to the formatted string.
SourceCodeFormatter	append(long i) Appends the provided long value to the formatted string.
<Stringable> SourceCodeFormatter	append(Stringable stringable) Appends the provided object's string representation to the formatted string.
char	charAt(int index)
boolean	contains(String text) Checks if the formatted string contains the specified text.
int	length() Retrieves the length of the current formatted string.
void	setLength(int len) Sets the length of the current formatted string.
CharSequence	subSequence(int start, int end)
@NotNull String	toString() Returns the formatted string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

SourceCodeFormatter

public SourceCodeFormatter(int indentSpaces,
                           AtomicInteger indent)

Constructor to initialize the formatter with given indent spaces and an atomic integer value.

Parameters:

indentSpaces - Number of spaces to use for indentation.

indent - Initial value for the atomic integer representing indentation count.

SourceCodeFormatter

public SourceCodeFormatter(int indentSpaces)

Constructor to initialize the formatter with given indent spaces and sets the default indentation count to 0.

Parameters:

indentSpaces - Number of spaces to use for indentation.

SourceCodeFormatter

public SourceCodeFormatter(int indentSpaces,
                           int i)

Constructor to initialize the formatter with given indent spaces and a specific integer value.

Parameters:

indentSpaces - Number of spaces to use for indentation.

i - Initial value for indentation count.

Method Detail

toString

@NotNull
public @NotNull String toString()

Returns the formatted string.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

The formatted code string.

append

public SourceCodeFormatter append(CharSequence csq)

Specified by:

append in interface Appendable

append

public SourceCodeFormatter append(CharSequence csq,
                                  int start,
                                  int end)

Specified by:

append in interface Appendable

append

public SourceCodeFormatter append(char c)

Specified by:

append in interface Appendable

setLength

public void setLength(int len)

Sets the length of the current formatted string. This can effectively truncate the existing content or extend it.

Parameters:

len - The new length for the formatted string.

length

public int length()

Retrieves the length of the current formatted string.

Specified by:

length in interface CharSequence

Returns:

The length of the formatted string.

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

append

public SourceCodeFormatter append(long i)

Appends the provided long value to the formatted string.

Parameters:

i - The long value to append.

Returns:

The current SourceCodeFormatter instance.

append

public SourceCodeFormatter append(double d)

Appends the provided double value to the formatted string.

Parameters:

d - The double value to append.

Returns:

The current SourceCodeFormatter instance.

append

public SourceCodeFormatter append(boolean flag)

Appends the provided boolean value to the formatted string.

Parameters:

flag - The boolean value to append.

Returns:

The current SourceCodeFormatter instance.

append

public <Stringable> SourceCodeFormatter append(Stringable stringable)

Appends the provided object's string representation to the formatted string. The object should have a meaningful string representation for this operation to be effective.

Type Parameters:

Stringable - The type of the object to be appended.

Parameters:

stringable - The object whose string representation will be appended.

Returns:

The current SourceCodeFormatter instance.

contains

public boolean contains(String text)

Checks if the formatted string contains the specified text.

Parameters:

text - The text to search for within the formatted string.

Returns:

True if the text exists within the formatted string, otherwise false.