Package org.approvej.configuration

Record Class Configuration

java.lang.Object

java.lang.Record

org.approvej.configuration.Configuration

Record Components:

defaultPrintFormat - the PrintFormat that will be used if none is specified otherwise

defaultFileReviewer - the Reviewer that will be used for file-based approvals if none is specified

inventoryEnabled - whether the approved file inventory is enabled

defaultInlineValueReviewer - the Reviewer that will be used for inline value approvals if none is specified

@NullMarked
public record Configuration(PrintFormat<Object> defaultPrintFormat, Reviewer defaultFileReviewer, boolean inventoryEnabled, Reviewer defaultInlineValueReviewer)
extends Record

Central configuration class for ApproveJ.

Configuration values can be set through multiple mechanisms, with the following priority (highest to lowest):

1. Environment variables (e.g., APPROVEJ_DEFAULT_PRINT_FORMAT)
2. Project properties (src/test/resources/approvej.properties)
3. User home properties (~/.config/approvej/approvej.properties)
4. Default values

Print formats and reviewers can be configured using either:

• Aliases (e.g., "json", "yaml", "singleLineString", "multiLineString" for print formats; "none", "automatic", "script", "ai" for reviewers)
• Fully-qualified class names (for backward compatibility and custom implementations)

The "script" reviewer requires the reviewerScript property to be set. The "ai" reviewer requires the reviewerAiCommand property to be set.

Field Summary

Fields

Modifier and Type	Field	Description
static final Configuration	configuration	The loaded Configuration object.

Constructor Summary

Constructors

Constructor	Description
Configuration(PrintFormat<Object> defaultPrintFormat, Reviewer defaultFileReviewer, boolean inventoryEnabled, Reviewer defaultInlineValueReviewer)	Creates an instance of a Configuration record class.

Method Summary

Modifier and Type	Method	Description
Reviewer	defaultFileReviewer()	Returns the value of the defaultFileReviewer record component.
Reviewer	defaultInlineValueReviewer()	Returns the value of the defaultInlineValueReviewer record component.
PrintFormat<Object>	defaultPrintFormat()	Returns the value of the defaultPrintFormat record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	inventoryEnabled()	Returns the value of the inventoryEnabled record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

configuration

public static final Configuration configuration

The loaded Configuration object.

Constructor Details

Configuration

public Configuration(PrintFormat<Object> defaultPrintFormat,
 Reviewer defaultFileReviewer,
 boolean inventoryEnabled,
 Reviewer defaultInlineValueReviewer)

Creates an instance of a Configuration record class.

Parameters:

defaultPrintFormat - the value for the defaultPrintFormat record component

defaultFileReviewer - the value for the defaultFileReviewer record component

inventoryEnabled - the value for the inventoryEnabled record component

defaultInlineValueReviewer - the value for the defaultInlineValueReviewer record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

defaultPrintFormat

public PrintFormat<Object> defaultPrintFormat()

Returns the value of the defaultPrintFormat record component.

Returns:

the value of the defaultPrintFormat record component

defaultFileReviewer

public Reviewer defaultFileReviewer()

Returns the value of the defaultFileReviewer record component.

Returns:

the value of the defaultFileReviewer record component

inventoryEnabled

public boolean inventoryEnabled()

Returns the value of the inventoryEnabled record component.

Returns:

the value of the inventoryEnabled record component

defaultInlineValueReviewer

public Reviewer defaultInlineValueReviewer()

Returns the value of the defaultInlineValueReviewer record component.

Returns:

the value of the defaultInlineValueReviewer record component