Module org.tquadrat.foundation.javacomposer

Package org.tquadrat.foundation.javacomposer.internal

Class Util

java.lang.Object

org.tquadrat.foundation.javacomposer.internal.Util

@UtilityClass
@ClassVersion(sourceVersion="$Id: Util.java 1085 2024-01-05 16:23:28Z tquadrat $")
public final class Util
extends Object

Several utility functions to be used with JavaComposer.

Author:

Square,Inc.

Modified by:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Util.java 1085 2024-01-05 16:23:28Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.javacomposer.internal.Util"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final Optional<DebugOutput>	NO_DEBUG_OUTPUT	The return value of createDebugOutput(boolean) when no debug output is desired.
static final Object	NULL_REFERENCE	The placeholder for null references.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Util()	No instance allowed for this class.

Method Summary

Modifier and Type	Method	Description
static final String	characterLiteralWithoutSingleQuotes(char c)	Translates the given character into a String; when that character is a special character, it will be escaped properly so that it can be used in a Java String literal.
static final Optional<DebugOutput>	createDebugOutput(boolean addDebugOutput)	Creates the debug output.
private static final Optional<StackTraceElement>	findCaller()	This method will find the method that makes the call into the Java Composer API and returns the appropriate stack trace element.
static final void	requireExactlyOneOf(Set<Modifier> modifiers, Modifier... mutuallyExclusive)	Checks whether the given Set of Modifier instances does contain one and only one of the Modifier instances given with the second argument, mutuallyExclusive.
static String	stringLiteralWithDoubleQuotes(String value, String indent)	Returns the Java String literal representing value, including escaping double quotes.
static final <T> Set<T>	union(Set<? extends T> firstSet, Set<? extends T> secondSet)	Creates a new set with the combined contents of the given sets.

Methods inherited from class java.lang.Object

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

Field Details

NULL_REFERENCE

@API(status=INTERNAL,
     since="0.0.5")
public static final Object NULL_REFERENCE

The placeholder for null references.

NO_DEBUG_OUTPUT

@API(status=INTERNAL,
     since="0.0.5")
public static final Optional<DebugOutput> NO_DEBUG_OUTPUT

The return value of createDebugOutput(boolean) when no debug output is desired.

Constructor Details

Util

private Util()

No instance allowed for this class.

Method Details

characterLiteralWithoutSingleQuotes

@API(status=INTERNAL,
     since="0.0.5")
public static final String characterLiteralWithoutSingleQuotes(char c)

Translates the given character into a String; when that character is a special character, it will be escaped properly so that it can be used in a Java String literal.

Parameters:

c - The input character.

Returns:

The target String.

See Also:

• The Java Language Specification: 3.10.6. Escape Sequences for Character and String Literals

createDebugOutput

@API(status=INTERNAL,
     since="0.0.5")
public static final Optional<DebugOutput> createDebugOutput(boolean addDebugOutput)

Creates the debug output.

Parameters:

addDebugOutput - true if some debug output should be added to the generated code, false otherwise.

Returns:

An instance of Optional that holds the debug output; empty if the parameter addDebugOutput is false.

See Also:

• NO_DEBUG_OUTPUT

findCaller

@API(status=INTERNAL,
     since="0.2.0")
private static final Optional<StackTraceElement> findCaller()

This method will find the method that makes the call into the Java Composer API and returns the appropriate stack trace element.

The respective method is determined by the package name of the containing class: it does not start with org.tquadrat.foundation.javacomposer.

Returns:

An instance of Optional that holds the stack trace element for the caller; will be empty if the call was internal.

stringLiteralWithDoubleQuotes

@API(status=INTERNAL,
     since="0.0.5")
public static String stringLiteralWithDoubleQuotes(String value,
 String indent)

Returns the Java String literal representing value, including escaping double quotes.

Parameters:

value - The input String.

indent - The indentation String that has to be added in case of a line break.

Returns:

The Java literal.

requireExactlyOneOf

@API(status=INTERNAL,
     since="0.0.5")
public static final void requireExactlyOneOf(Set<Modifier> modifiers,
 Modifier... mutuallyExclusive)
                                      throws ValidationException

Checks whether the given Set of Modifier instances does contain one and only one of the Modifier instances given with the second argument, mutuallyExclusive.

Parameters:

modifiers - The set to check.

mutuallyExclusive - A list of values from which one and only one must be in the modifiers set.

Throws:

ValidationException - None or more than one Modifier instance was found.

union

@API(status=INTERNAL,
     since="0.0.5")
public static final <T> Set<T> union(Set<? extends T> firstSet,
 Set<? extends T> secondSet)

Creates a new set with the combined contents of the given sets.

Type Parameters:

T - The type of the set elements.

Parameters:

firstSet - The first set.

secondSet - The second set.

Returns:

The combined set.