Record Class InputEnumerationOptions

java.lang.Object

java.lang.Record

dev.archunitjava.importer.InputEnumerationOptions

public record InputEnumerationOptions(int maximumInputs, int maximumResourcesPerInput, int maximumDirectoryDepth, int maximumDirectoryEntries, int maximumArchiveEntries, long maximumArchiveBytes, long maximumArchiveUncompressedBytes, int maximumCompressionRatio, int maximumArchiveNestingDepth, int maximumResourceNameCharacters, int maximumDiagnostics)
extends Record

Immutable safety bounds for class-file input traversal.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_MAXIMUM_ARCHIVE_BYTES
static final int	DEFAULT_MAXIMUM_ARCHIVE_ENTRIES
static final int	DEFAULT_MAXIMUM_ARCHIVE_NESTING_DEPTH
static final long	DEFAULT_MAXIMUM_ARCHIVE_UNCOMPRESSED_BYTES
static final int	DEFAULT_MAXIMUM_COMPRESSION_RATIO
static final int	DEFAULT_MAXIMUM_DIAGNOSTICS
static final int	DEFAULT_MAXIMUM_DIRECTORY_DEPTH
static final int	DEFAULT_MAXIMUM_DIRECTORY_ENTRIES
static final int	DEFAULT_MAXIMUM_INPUTS
static final int	DEFAULT_MAXIMUM_RESOURCE_NAME_CHARACTERS
static final int	DEFAULT_MAXIMUM_RESOURCES

Constructor Summary

Constructors

Constructor	Description
InputEnumerationOptions(int maximumResourcesPerInput, int maximumDirectoryDepth, int maximumDirectoryEntries, int maximumArchiveEntries)
InputEnumerationOptions(int maximumInputs, int maximumResourcesPerInput, int maximumDirectoryDepth, int maximumDirectoryEntries, int maximumArchiveEntries, long maximumArchiveBytes, long maximumArchiveUncompressedBytes, int maximumCompressionRatio, int maximumArchiveNestingDepth, int maximumResourceNameCharacters, int maximumDiagnostics)	Creates an instance of a InputEnumerationOptions record class.

Method Summary

Modifier and Type	Method	Description
static InputEnumerationOptions	defaults()
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.
long	maximumArchiveBytes()	Returns the value of the maximumArchiveBytes record component.
int	maximumArchiveEntries()	Returns the value of the maximumArchiveEntries record component.
int	maximumArchiveNestingDepth()	Returns the value of the maximumArchiveNestingDepth record component.
long	maximumArchiveUncompressedBytes()	Returns the value of the maximumArchiveUncompressedBytes record component.
int	maximumCompressionRatio()	Returns the value of the maximumCompressionRatio record component.
int	maximumDiagnostics()	Returns the value of the maximumDiagnostics record component.
int	maximumDirectoryDepth()	Returns the value of the maximumDirectoryDepth record component.
int	maximumDirectoryEntries()	Returns the value of the maximumDirectoryEntries record component.
int	maximumInputs()	Returns the value of the maximumInputs record component.
int	maximumResourceNameCharacters()	Returns the value of the maximumResourceNameCharacters record component.
int	maximumResourcesPerInput()	Returns the value of the maximumResourcesPerInput record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

DEFAULT_MAXIMUM_INPUTS

public static final int DEFAULT_MAXIMUM_INPUTS

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_RESOURCES

public static final int DEFAULT_MAXIMUM_RESOURCES

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_DIRECTORY_DEPTH

public static final int DEFAULT_MAXIMUM_DIRECTORY_DEPTH

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_DIRECTORY_ENTRIES

public static final int DEFAULT_MAXIMUM_DIRECTORY_ENTRIES

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_ARCHIVE_ENTRIES

public static final int DEFAULT_MAXIMUM_ARCHIVE_ENTRIES

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_ARCHIVE_BYTES

public static final long DEFAULT_MAXIMUM_ARCHIVE_BYTES

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_ARCHIVE_UNCOMPRESSED_BYTES

public static final long DEFAULT_MAXIMUM_ARCHIVE_UNCOMPRESSED_BYTES

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_COMPRESSION_RATIO

public static final int DEFAULT_MAXIMUM_COMPRESSION_RATIO

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_ARCHIVE_NESTING_DEPTH

public static final int DEFAULT_MAXIMUM_ARCHIVE_NESTING_DEPTH

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_RESOURCE_NAME_CHARACTERS

public static final int DEFAULT_MAXIMUM_RESOURCE_NAME_CHARACTERS

See Also:

• Constant Field Values

DEFAULT_MAXIMUM_DIAGNOSTICS

public static final int DEFAULT_MAXIMUM_DIAGNOSTICS

See Also:

• Constant Field Values

Constructor Details

InputEnumerationOptions

public InputEnumerationOptions(int maximumInputs,
 int maximumResourcesPerInput,
 int maximumDirectoryDepth,
 int maximumDirectoryEntries,
 int maximumArchiveEntries,
 long maximumArchiveBytes,
 long maximumArchiveUncompressedBytes,
 int maximumCompressionRatio,
 int maximumArchiveNestingDepth,
 int maximumResourceNameCharacters,
 int maximumDiagnostics)

Creates an instance of a InputEnumerationOptions record class.

Parameters:

maximumInputs - the value for the maximumInputs record component

maximumResourcesPerInput - the value for the maximumResourcesPerInput record component

maximumDirectoryDepth - the value for the maximumDirectoryDepth record component

maximumDirectoryEntries - the value for the maximumDirectoryEntries record component

maximumArchiveEntries - the value for the maximumArchiveEntries record component

maximumArchiveBytes - the value for the maximumArchiveBytes record component

maximumArchiveUncompressedBytes - the value for the maximumArchiveUncompressedBytes record component

maximumCompressionRatio - the value for the maximumCompressionRatio record component

maximumArchiveNestingDepth - the value for the maximumArchiveNestingDepth record component

maximumResourceNameCharacters - the value for the maximumResourceNameCharacters record component

maximumDiagnostics - the value for the maximumDiagnostics record component

InputEnumerationOptions

public InputEnumerationOptions(int maximumResourcesPerInput,
 int maximumDirectoryDepth,
 int maximumDirectoryEntries,
 int maximumArchiveEntries)

Method Details

defaults

public static InputEnumerationOptions defaults()

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. All components in this record class are compared with the compare method from their corresponding wrapper classes.

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.

maximumInputs

public int maximumInputs()

Returns the value of the maximumInputs record component.

Returns:

the value of the maximumInputs record component

maximumResourcesPerInput

public int maximumResourcesPerInput()

Returns the value of the maximumResourcesPerInput record component.

Returns:

the value of the maximumResourcesPerInput record component

maximumDirectoryDepth

public int maximumDirectoryDepth()

Returns the value of the maximumDirectoryDepth record component.

Returns:

the value of the maximumDirectoryDepth record component

maximumDirectoryEntries

public int maximumDirectoryEntries()

Returns the value of the maximumDirectoryEntries record component.

Returns:

the value of the maximumDirectoryEntries record component

maximumArchiveEntries

public int maximumArchiveEntries()

Returns the value of the maximumArchiveEntries record component.

Returns:

the value of the maximumArchiveEntries record component

maximumArchiveBytes

public long maximumArchiveBytes()

Returns the value of the maximumArchiveBytes record component.

Returns:

the value of the maximumArchiveBytes record component

maximumArchiveUncompressedBytes

public long maximumArchiveUncompressedBytes()

Returns the value of the maximumArchiveUncompressedBytes record component.

Returns:

the value of the maximumArchiveUncompressedBytes record component

maximumCompressionRatio

public int maximumCompressionRatio()

Returns the value of the maximumCompressionRatio record component.

Returns:

the value of the maximumCompressionRatio record component

maximumArchiveNestingDepth

public int maximumArchiveNestingDepth()

Returns the value of the maximumArchiveNestingDepth record component.

Returns:

the value of the maximumArchiveNestingDepth record component

maximumResourceNameCharacters

public int maximumResourceNameCharacters()

Returns the value of the maximumResourceNameCharacters record component.

Returns:

the value of the maximumResourceNameCharacters record component

maximumDiagnostics

public int maximumDiagnostics()

Returns the value of the maximumDiagnostics record component.

Returns:

the value of the maximumDiagnostics record component