ResolverReference

class ResolverReference( val resolver: ModuleRootResolver, val uri: URI, val qualifiedName: String, val type: ResourceType, mimeType: String, lastModified: Long, size: Long, localName: String = "", val forcedDigest: ByteArray? = null)

A ResolverReference is a reference to a module or a module resource within a ModuleRoot produced by a ModuleRootResolver.

Author

Richard Arriaga

Parameters

resolver

The ModuleRoot the file referenced by ResolverReference belongs to.

The URI of the file this ResolverReference refers to.

qualifiedName

The fully-qualified name of the module or resource.

type

The ResourceType that describes what this reference points to.

mimeType

The file MIME type of the associated resource.

lastModified

The time in millis since the unix epoch, preferably UTC, when this was last modified. This value will be zero for directories.

size

The size in bytes of the file or 0 if a directory.

Constructors

ResolverReference

fun ResolverReference( resolver: ModuleRootResolver, uri: URI, qualifiedName: String, type: ResourceType, mimeType: String, lastModified: Long, size: Long, localName: String = "", forcedDigest: ByteArray? = null)

Construct a ResolverReference.

Types

Companion

object Companion

Functions

childReferences

fun childReferences(includeResources: Boolean): List<ResolverReference>

Answer the List of child ResolverReferences owned by the ResolverReference.

equals

open operator override fun equals(other: Any?): Boolean

file

fun file(rawBytes: ByteArray): AvailFile

Answer an AvailFile for the given raw bytes. This should be the contents of the file represented by this ResolverReference.

hashCode

open override fun hashCode(): Int

isChildOf

fun isChildOf(reference: ResolverReference): Boolean

Is this ResolverReference a direct child of the provided ResolverReference?

isDescendantOf

fun isDescendantOf(reference: ResolverReference): Boolean

Is this ResolverReference a descendant of the provided ResolverReference?

readFileBytes

fun readFileBytes( bypassFileManager: Boolean, withContents: (ByteArray, UUID?) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Retrieve the resource and provide it with a request to obtain the raw file bytes.

readFileString

fun readFileString( bypassFileManager: Boolean, withContents: (String, UUID?) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

refresh

fun refresh(lastModified: Long, size: Long)

Update the mutable state of this ResolverReference.

toString

open override fun toString(): String

walkChildrenThen

fun walkChildrenThen( visitResources: Boolean, withReference: (ResolverReference) -> Unit, afterAllVisited: (Int) -> Unit = {})

Walk the children of this ResolverReference. This reference must be either a root, package, or directory.

writeOn

fun writeOn(writer: JSONWriter, builder: AvailBuilder)

Write the ModuleNode to the supplied JSONWriter.

Properties

accessException

var accessException: Throwable? = null

The exception that prevented the most recent attempt at accessing the source location of this ResolverReference.

forcedDigest

val forcedDigest: ByteArray? = null

If the source file's digest was captured within a jar file, always use it as the digest, and never computed it.

hasChildren

val hasChildren: Boolean

true indicates that either modules or resources is not empty. false indicates they are both empty.

isModule

val isModule: Boolean

true iff the ResolverReference represents a module, false otherwise.

isPackage

val isPackage: Boolean

true iff the ResolverReference represents a package, false otherwise.

isPackageRepresentative

val isPackageRepresentative: Boolean

true iff the ResolverReference represents a package representative module, false otherwise.

isResource

val isResource: Boolean

Indicates whether or not this ResolverReference is a resource, not a module nor package. true if it is either a ResourceType.RESOURCE or ResourceType.DIRECTORY; false otherwise.