Record Class ResolverContext

java.lang.Object

java.lang.Record

dev.jcputney.mjml.ResolverContext

Record Components:

includingPath - the path of the file that contains the mj-include, or null for the root document

includeType - the include type (e.g. "mjml", "html", "css", "css-inline")

depth - the current nesting depth (0 for top-level includes)

public record ResolverContext(String includingPath, String includeType, int depth)
extends Record

Context information passed to IncludeResolver when resolving includes. Provides metadata about the include chain: which file is doing the including, what type of include it is, and how deep in the include chain we are.

Constructor Summary

Constructors

Constructor	Description
ResolverContext(String includingPath, String includeType, int depth)	Creates an instance of a ResolverContext record class.

Method Summary

Modifier and Type	Method	Description
int	depth()	Returns the value of the depth 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.
String	includeType()	Returns the value of the includeType record component.
String	includingPath()	Returns the value of the includingPath record component.
ResolverContext	nested(String newIncludingPath)	Creates a nested context for includes within included files.
static ResolverContext	root(String includeType)	Creates a root context for top-level includes.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ResolverContext

public ResolverContext(String includingPath,
 String includeType,
 int depth)

Creates an instance of a ResolverContext record class.

Parameters:

includingPath - the value for the includingPath record component

includeType - the value for the includeType record component

depth - the value for the depth record component

Method Details

root

public static ResolverContext root(String includeType)

Creates a root context for top-level includes.

Parameters:

includeType - the include type

Returns:

a new context with null includingPath and depth 0

nested

public ResolverContext nested(String newIncludingPath)

Creates a nested context for includes within included files.

Parameters:

newIncludingPath - the path of the file that contains the nested include

Returns:

a new context with incremented depth

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 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.

includingPath

public String includingPath()

Returns the value of the includingPath record component.

Returns:

the value of the includingPath record component

includeType

public String includeType()

Returns the value of the includeType record component.

Returns:

the value of the includeType record component

depth

public int depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component