Top Description Fields Constructors Methods
org.jooq.conf

public Class RenderFormatting

extends SettingsBase
implements Serializable, Cloneable, XMLAppendable
Class Inheritance
All Implemented Interfaces
org.jooq.util.jaxb.tools.XMLAppendable, java.lang.Cloneable, java.io.Serializable
Annotations
@XmlAccessorType:FIELD
@XmlType
name:RenderFormatting
propOrder:
@SuppressWarnings:all
Imports
java.io.Serializable, jakarta.xml.bind.annotation.XmlAccessType, .XmlAccessorType, .XmlElement, .XmlType, org.jooq.util.jaxb.tools.XMLAppendable, .XMLBuilder

All sorts of formatting flags / settings.

Field Summary

Modifier and TypeField and Description
protected String
protected String
protected Integer
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public final void
public boolean
equals(Object
the reference object with which to compare.
that
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
getIndentation()

The characters to be used for indentation.

public String
getNewline()

The character to be used for line breaks.

public Integer
getPrintMargin()

The print margin after which (some) formatted elements will break lines.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public void
setIndentation(String value)

The characters to be used for indentation.

public void
setNewline(String value)

The character to be used for line breaks.

public void
setPrintMargin(Integer value)

The print margin after which (some) formatted elements will break lines.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public RenderFormatting
withIndentation(String value)

The characters to be used for indentation.

public RenderFormatting
withNewline(String value)

The character to be used for line breaks.

public RenderFormatting
withPrintMargin(Integer value)

The print margin after which (some) formatted elements will break lines.

Inherited from org.jooq.conf.SettingsBase:
clone

Field Detail

indentationback to summary
protected String indentation
Annotations
@XmlElement
defaultValue:
newlineback to summary
protected String newline
Annotations
@XmlElement
defaultValue:
printMarginback to summary
protected Integer printMargin
Annotations
@XmlElement
defaultValue:80
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

RenderFormattingback to summary
public RenderFormatting()

Method Detail

appendToback to summary
public final void appendTo(XMLBuilder builder)

Implements org.jooq.util.jaxb.tools.XMLAppendable.appendTo.

Annotations
@Override
equalsback to summary
public boolean equals(Object that)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
that:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getIndentationback to summary
public String getIndentation()

The characters to be used for indentation.

getNewlineback to summary
public String getNewline()

The character to be used for line breaks.

getPrintMarginback to summary
public Integer getPrintMargin()

The print margin after which (some) formatted elements will break lines.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
setIndentationback to summary
public void setIndentation(String value)

The characters to be used for indentation.

setNewlineback to summary
public void setNewline(String value)

The character to be used for line breaks.

setPrintMarginback to summary
public void setPrintMargin(Integer value)

The print margin after which (some) formatted elements will break lines.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
withIndentationback to summary
public RenderFormatting withIndentation(String value)

The characters to be used for indentation.

withNewlineback to summary
public RenderFormatting withNewline(String value)

The character to be used for line breaks.

withPrintMarginback to summary
public RenderFormatting withPrintMargin(Integer value)

The print margin after which (some) formatted elements will break lines.