org.gradle.api.internal.plugins

Class DslObject

java.lang.Object

org.gradle.api.internal.plugins.DslObject

All Implemented Interfaces:

DynamicObjectAware, HasConvention, IConventionAware, ExtensionAware

public class DslObject
extends java.lang.Object
implements DynamicObjectAware, ExtensionAware, IConventionAware, HasConvention

Provides a unified, typed, interface to an enhanced DSL object. This is intended to be used with objects that have been decorated by the class generator.

Accessing each ?aspect? of a DSL object may fail (with an IllegalStateException) if the DSL object does not have that functionality. For example, calling getConventionMapping() will fail if the backing object does not implement IConventionAware.

Constructor Summary

Constructors

Constructor and Description
DslObject(java.lang.Object object)

Method Summary

Methods

Modifier and Type	Method and Description
DynamicObject	getAsDynamicObject() Returns a DynamicObject for this object.
Convention	getConvention()
ConventionMapping	getConventionMapping() Returns the convention mapping for the properties of this object.
ExtensionContainer	getExtensions() The container of extensions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DslObject

public DslObject(java.lang.Object object)

Method Detail

getAsDynamicObject

public DynamicObject getAsDynamicObject()

Description copied from interface: DynamicObjectAware

Returns a DynamicObject for this object.

Specified by:

getAsDynamicObject in interface DynamicObjectAware

Returns:

The dynamic object.

getConvention

public Convention getConvention()

Specified by:

getConvention in interface HasConvention

getExtensions

public ExtensionContainer getExtensions()

Description copied from interface: ExtensionAware

The container of extensions.

Specified by:

getExtensions in interface ExtensionAware

getConventionMapping

public ConventionMapping getConventionMapping()

Description copied from interface: IConventionAware

Returns the convention mapping for the properties of this object. The returned mapping object can be used to manage the mapping for individual properties.

Specified by:

getConventionMapping in interface IConventionAware

Returns:

The mapping. Never returns null.