QualifiedContent

View Source

Added in 4.2.0

Deprecated in 7.0.0

interface QualifiedContent

Known direct subclasses

DirectoryInput, JarInput

DirectoryInput	This interface is deprecated.
JarInput	This interface is deprecated.

---

This interface is deprecated.

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

Summary

Nested types
interface QualifiedContent.ContentType A content type that is requested through the transform API.
enum QualifiedContent.DefaultContentType : QualifiedContent.ContentType The type of of the content.
enum QualifiedContent.Scope : QualifiedContent.ScopeType The scope of the content.
interface QualifiedContent.ScopeType Definition of a scope.

Public functions
(Mutable)Set<QualifiedContent.ContentType!>!	getContentTypes() Returns the type of content that the stream represents.
File!	getFile() Returns he location of the content.
String!	getName() Returns the name of the content.
(Mutable)Set<Any!>!	getScopes() Returns the scope of the content.

Public functions

getContentTypes

Added in 4.2.0

Deprecated in 7.0.0

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

Added in 4.2.0

Deprecated in 7.0.0

fun getFile(): File!

Returns he location of the content.

Returns
File!	the content location.

getName

Added in 4.2.0

Deprecated in 7.0.0

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

Added in 4.2.0

Deprecated in 7.0.0

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.