gradle/org.gradle.model

Package-level declarations

Classes that operate upon the Gradle model.

Types

ConfigurationCycleException

@Incubating

open class ConfigurationCycleException : GradleException

Thrown when a cycle is encountered while configuring a model element.

Defaults

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class Defaults

Denotes that the RuleSource method rule carrying this annotation initializes the rule subject with default values.

Each

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.PARAMETER)

@Incubating

annotation class Each

Signals that a RuleSource rule should be applied to all matching descendant elements of the scope instead of the scope itself.

Finalize

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class Finalize

Denotes that the RuleSource method rule carrying this annotation finalizes the rule subject.

InvalidModelRuleDeclarationException

@Incubating

open class InvalidModelRuleDeclarationException : GradleException

Thrown when a model rule, or source of model rules, is declared in an invalid way.

InvalidModelRuleException

@Incubating

open class InvalidModelRuleException : GradleException

Thrown when there is a problem with the usage of a model rule.

Managed

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.TYPE)

@Incubating

annotation class Managed

A managed type is transparent to the model space, and enforces immutability at the appropriate times in the object's lifecycle.

Model

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class Model

Denotes that the RuleSource method rule carrying this annotation creates a new top level element in the model space.

ModelElement

@Incubating

interface ModelElement : Named

Represents an element in a model.

ModelMap

@Incubating

interface ModelMap<T> : Iterable<T> , ModelElement

Model backed map like structure allowing adding of items where instantiation is managed.

ModelRuleBindingException

@Incubating

open class ModelRuleBindingException : GradleException

Thrown when there is a problem binding the model element references of a model rule.

ModelSet

@Incubating

interface ModelSet<T> : Set<E> , ModelElement

A set of managed model objects.

ModelViewClosedException

@Incubating

open class ModelViewClosedException : ReadOnlyModelViewException

Thrown when at attempt is made to mutate a subject of a rule after the rule has completed.

Mutate

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class Mutate

Denotes that the RuleSource method rule carrying this annotation mutates the rule subject.

Path

@Target(value = [ElementType.PARAMETER])

@Retention(value = RetentionPolicy.RUNTIME)

@Incubating

annotation class Path

Specifies a model path on a parameter

ReadOnlyModelViewException

@Incubating

open class ReadOnlyModelViewException : GradleException

Thrown when an attempt is made to change the value of a model element that is not writable at the time.

RuleInput

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class RuleInput

Attached to the getter for a property on a RuleSource to denote that the property defines an implicit input for all rules defined by the rule source.

Rules

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class Rules

Denotes that the RuleSource method rule carrying this annotation defines additional rules based on its inputs.

RuleSource

@Incubating

open class RuleSource

A marker type for a class that is a collection of rules.

RuleTarget

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class RuleTarget

Attached to the getter for a property on a RuleSource to denote that the property defines the target for the rule source.

Unmanaged

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class Unmanaged

Indicates that a property of a managed model element is explicitly of an unmanaged type.

Validate

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

@Incubating

annotation class Validate

Denotes that the RuleSource method rule carrying this annotation validates the rule subject.

WriteOnlyModelViewException

@Incubating

open class WriteOnlyModelViewException : GradleException

Thrown when an attempt is made to read the value of a model element that is not readable at the time.