Package org.grails.core.artefact

Class DomainClassArtefactHandler

java.lang.Object

grails.core.ArtefactHandlerAdapter

org.grails.core.artefact.DomainClassArtefactHandler

All Implemented Interfaces:

ArtefactHandler, GrailsApplicationAware, org.springframework.beans.factory.Aware, org.springframework.core.Ordered

Direct Known Subclasses:

AnnotationDomainClassArtefactHandler

public class DomainClassArtefactHandler
extends ArtefactHandlerAdapter
implements GrailsApplicationAware, org.springframework.core.Ordered

Evaluates the conventions that define a domain class in Grails.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PLUGIN_NAME
static java.lang.String	TYPE

Fields inherited from class grails.core.ArtefactHandlerAdapter

allowAbstract, artefactSuffix, grailsClassImpl, grailsClassType, type

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DomainClassArtefactHandler()

Method Summary

Modifier and Type	Method	Description
int	getOrder()
java.lang.String	getPluginName()	Obtains the plugin name that deals with this artefact.
boolean	isArtefact(org.codehaus.groovy.ast.ClassNode classNode)	Default implementation of ArtefactHandler.isArtefact(org.codehaus.groovy.ast.ClassNode) which returns true if the ClassNode passes the ArtefactHandlerAdapter.isArtefactResource(org.grails.io.support.Resource) method and the name of the ClassNode ends with the ArtefactHandlerAdapter.artefactSuffix
boolean	isArtefactClass(java.lang.Class clazz)	Checks that class's name ends in the suffix specified for this handler.
protected boolean	isArtefactResource(org.grails.io.support.Resource resource)	Subclasses can override to narrow down whether the given resource is an artefact of this type.
static boolean	isDomainClass(java.lang.Class<?> clazz)
static boolean	isDomainClass(java.lang.Class<?> clazz, boolean allowProxyClass)
protected boolean	isValidArtefactClassNode(org.codehaus.groovy.ast.ClassNode classNode, int modifiers)
GrailsClass	newArtefactClass(java.lang.Class artefactClass)	Creates new GrailsClass derived object using the type supplied in constructor.
GrailsClass	newArtefactClass(java.lang.Class artefactClass, org.grails.datastore.mapping.model.MappingContext mappingContext)
void	setGrailsApplication(GrailsApplication grailsApplication)	This method is called by the ApplicationContext that loads the Grails application.

Methods inherited from class grails.core.ArtefactHandlerAdapter

getArtefactForFeature, getType, initialize, isArtefact, isArtefactGrailsClass

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

PLUGIN_NAME

public static final java.lang.String PLUGIN_NAME

See Also:

Constant Field Values

Constructor Detail

DomainClassArtefactHandler

public DomainClassArtefactHandler()

Method Detail

setGrailsApplication

public void setGrailsApplication(GrailsApplication grailsApplication)

Description copied from interface: GrailsApplicationAware

This method is called by the ApplicationContext that loads the Grails application. The GrailsApplication instance that represents the loaded Grails application is injected.

Specified by:

setGrailsApplication in interface GrailsApplicationAware

Parameters:

grailsApplication - the GrailsApplication object that represents this Grails application

getPluginName

public java.lang.String getPluginName()

Description copied from interface: ArtefactHandler

Obtains the plugin name that deals with this artefact.

Specified by:

getPluginName in interface ArtefactHandler

Overrides:

getPluginName in class ArtefactHandlerAdapter

Returns:

The plugin name or null if there isn't one

newArtefactClass

public GrailsClass newArtefactClass(java.lang.Class artefactClass)

Description copied from class: ArtefactHandlerAdapter

Creates new GrailsClass derived object using the type supplied in constructor. May not perform optimally but is a convenience.

Specified by:

newArtefactClass in interface ArtefactHandler

Overrides:

newArtefactClass in class ArtefactHandlerAdapter

Parameters:

artefactClass - Creates a new artefact for the given class

Returns:

An instance of the GrailsClass interface representing the artefact

newArtefactClass

public GrailsClass newArtefactClass(java.lang.Class artefactClass,
                                    org.grails.datastore.mapping.model.MappingContext mappingContext)

isArtefactResource

protected boolean isArtefactResource(org.grails.io.support.Resource resource)
                              throws java.io.IOException

Description copied from class: ArtefactHandlerAdapter

Subclasses can override to narrow down whether the given resource is an artefact of this type. The default is to consider all files under "grails-app" to be a resource

Overrides:

isArtefactResource in class ArtefactHandlerAdapter

Parameters:

resource - The resource

Returns:

True if it is a Grails artefact

Throws:

java.io.IOException

isValidArtefactClassNode

protected boolean isValidArtefactClassNode(org.codehaus.groovy.ast.ClassNode classNode,
                                           int modifiers)

Overrides:

isValidArtefactClassNode in class ArtefactHandlerAdapter

isArtefact

public boolean isArtefact(org.codehaus.groovy.ast.ClassNode classNode)

Description copied from class: ArtefactHandlerAdapter

Default implementation of ArtefactHandler.isArtefact(org.codehaus.groovy.ast.ClassNode) which returns true if the ClassNode passes the ArtefactHandlerAdapter.isArtefactResource(org.grails.io.support.Resource) method and the name of the ClassNode ends with the ArtefactHandlerAdapter.artefactSuffix

Specified by:

isArtefact in interface ArtefactHandler

Overrides:

isArtefact in class ArtefactHandlerAdapter

Parameters:

classNode - The ClassNode instance

Returns:

True if the ClassNode is an artefact of this type

isArtefactClass

public boolean isArtefactClass(java.lang.Class clazz)

Description copied from class: ArtefactHandlerAdapter

Checks that class's name ends in the suffix specified for this handler.

Override for more complex criteria

Overrides:

isArtefactClass in class ArtefactHandlerAdapter

Parameters:

clazz - The class to check

Returns:

true if it is an artefact of this type

isDomainClass

public static boolean isDomainClass(java.lang.Class<?> clazz,
                                    boolean allowProxyClass)

isDomainClass

public static boolean isDomainClass(java.lang.Class<?> clazz)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered