Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer

Enum Class Layout

java.lang.Object

java.lang.Enum<Layout>

org.tquadrat.foundation.javacomposer.Layout

All Implemented Interfaces:

Serializable, Comparable<Layout>, Constable, LayoutWriter

@ClassVersion(sourceVersion="$Id: Layout.java 855 2021-01-21 20:22:52Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public enum Layout
extends Enum<Layout>
implements LayoutWriter

The various possible layouts for the output created by JavaFile.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Layout.java 855 2021-01-21 20:22:52Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.Layout"

⁠

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LAYOUT_DEFAULT	The default layout; same as LAYOUT_JAVAPOET.
LAYOUT_FOUNDATION	The layout as used for the Foundation library.
LAYOUT_JAVAPOET	The layout for the original JavaPoet.
LAYOUT_JAVAPOET_WITH_TAB	The layout for the original JavaPoet, but using the tabulator character for the indentation, instead of blanks.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	m_Indentation	The indentation String.
private final int	m_TabSize	The tabulator size.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Layout(boolean useTab, int tabSize)	Creates a new instance for Layout.

Method Summary

Modifier and Type	Method	Description
final String	indent()	Returns the indentation String for this layout.
final int	tabsize()	Returns the tabulator size this layout was configured with.
static Layout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Layout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LAYOUT_FOUNDATION

@API(status=STABLE,
     since="0.0.5")
public static final Layout LAYOUT_FOUNDATION

The layout as used for the Foundation library.

The layout of the generated Java file does not follow that of the Foundation library source completely as this would require to much effort to implement. Additionally, the code that is provided for the method bodies will not be parsed, so variations in the layout here will not be corrected.

Here must be especially mentioned the methods CodeBlock.Builder.beginControlFlow(String, Object...), CodeBlock.Builder.nextControlFlow(String, Object...) and CodeBlock.Builder.endControlFlow(String, Object...): these will generate code like this:

  if( flag ) {
      doThis();
  } else {
      doSomethingDifferent(); }

while the Foundation layout would look like this:

  if( flag )
  {
      doThis();
  }
  else
  {
      doSomethingDifferent();
  }

But these differences are seen as neglectable.

TODO Adjust this comment!!

LAYOUT_JAVAPOET

@API(status=STABLE,
     since="0.0.5")
public static final Layout LAYOUT_JAVAPOET

The layout for the original JavaPoet.

LAYOUT_JAVAPOET_WITH_TAB

@API(status=STABLE,
     since="0.2.0")
public static final Layout LAYOUT_JAVAPOET_WITH_TAB

The layout for the original JavaPoet, but using the tabulator character for the indentation, instead of blanks.

LAYOUT_DEFAULT

@API(status=STABLE,
     since="0.0.5")
public static final Layout LAYOUT_DEFAULT

The default layout; same as LAYOUT_JAVAPOET.

Field Details

m_Indentation

private final String m_Indentation

The indentation String.

m_TabSize

private final int m_TabSize

The tabulator size.

Constructor Details

Layout

private Layout(boolean useTab,
 int tabSize)

Creates a new instance for Layout.

Parameters:

useTab - true if the tabulator should be used for the indentation, false if blanks should be used.

tabSize - The tabulator size.

Method Details

values

public static Layout[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Layout valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

indent

public final String indent()

Returns the indentation String for this layout.

Specified by:

indent in interface LayoutWriter

Returns:

The indentation.

tabsize

public final int tabsize()

Returns the tabulator size this layout was configured with.

Specified by:

tabsize in interface LayoutWriter

Returns:

The tabulator size.