Package lib.aide.resource.content

Record Class ResourceFactory.MapFromTextResult

java.lang.Object

java.lang.Record

lib.aide.resource.content.ResourceFactory.MapFromTextResult

Record Components:

result - The resulting map from the file's content.

isValid - Whether the mapping operation was successful.

issues - A list of exceptions encountered during the mapping process.

textContent - The original text content that was parsed.

contentType - The type of content that was parsed (JSON or YAML).

Enclosing class:

ResourceFactory

public static record ResourceFactory.MapFromTextResult(Map<String,Object> result, boolean isValid, List<Exception> issues, String textContent, ResourceFactory.MapFromTextContentType contentType)
extends Record

A record to encapsulate the result of mapping a file's content to a Map, the validity of the operation, any issues encountered during the process, and the type of content parsed.

Constructor Summary

Constructors

Constructor	Description
MapFromTextResult(Map<String,Object> result, boolean isValid, List<Exception> issues, String textContent, ResourceFactory.MapFromTextContentType contentType)	Creates an instance of a MapFromTextResult record class.

Method Summary

Modifier and Type	Method	Description
ResourceFactory.MapFromTextContentType	contentType()	Returns the value of the contentType 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.
List<Exception>	issues()	Returns the value of the issues record component.
boolean	isValid()	Returns the value of the isValid record component.
Map<String,Object>	result()	Returns the value of the result record component.
String	textContent()	Returns the value of the textContent record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MapFromTextResult

public MapFromTextResult(Map<String,Object> result,
 boolean isValid,
 List<Exception> issues,
 String textContent,
 ResourceFactory.MapFromTextContentType contentType)

Creates an instance of a MapFromTextResult record class.

Parameters:

result - the value for the result record component

isValid - the value for the isValid record component

issues - the value for the issues record component

textContent - the value for the textContent record component

contentType - the value for the contentType 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.

result

public Map<String,Object> result()

Returns the value of the result record component.

Returns:

the value of the result record component

isValid

public boolean isValid()

Returns the value of the isValid record component.

Returns:

the value of the isValid record component

issues

public List<Exception> issues()

Returns the value of the issues record component.

Returns:

the value of the issues record component

textContent

public String textContent()

Returns the value of the textContent record component.

Returns:

the value of the textContent record component

contentType

public ResourceFactory.MapFromTextContentType contentType()

Returns the value of the contentType record component.

Returns:

the value of the contentType record component