Stay organized with collections Save and categorize content based on your preferences.

QualifiedContent

interface QualifiedContent

Known direct subclasses
DirectoryInput

This interface is deprecated.

JarInput

This interface is deprecated.


Represent content qualified with one or more ContentType and one or more Scope.

Summary

Nested types

QualifiedContent.ContentType

A content type that is requested through the transform API.

QualifiedContent.DefaultContentType

The type of of the content.

QualifiedContent.Scope

The scope of the content.

QualifiedContent.ScopeType

Definition of a scope.

Public functions

(Mutable)Set<QualifiedContent.ContentType!>

Returns the type of content that the stream represents.

File

Returns he location of the content.

String

Returns the name of the content.

(Mutable)Set<Any!>

Returns the scope of the content.

Public functions

getContentTypes

fun getContentTypes(): (Mutable)Set<QualifiedContent.ContentType!>

Returns the type of content that the stream represents.

Even though this may return only RESOURCES or CLASSES, the actual content (the folder or the jar) may contain files representing other content types. This is because the transform mechanism avoids duplicating files around to remove unwanted types for performance.

For each input, transforms should always take care to read and process only the files associated with the types returned by this method.

Returns
(Mutable)Set<QualifiedContent.ContentType!>

a set of one or more types, never null nor empty.

getFile

fun getFile(): File

Returns he location of the content.

Returns
File

the content location.

getName

fun getName(): String

Returns the name of the content. Can be used to differentiate different content using the same scope. This is not reliably usable at every stage of the transformations, but can be used for logging for instance.

Returns
String

the name

getScopes

fun getScopes(): (Mutable)Set<Any!>

Returns the scope of the content.

Returns
(Mutable)Set<Any!>

a set of one or more scopes, never null nor empty.