ArtefactHandlerAdapter (Grace Framework

grails.core.ArtefactHandlerAdapter

All Implemented Interfaces and Traits:

ArtefactHandler
```
public class ArtefactHandlerAdapter
extends Object
implements ArtefactHandler
```
Adapter for the ArtefactHandler interface
Authors:
Marc Palmer (marc@anyware.co.uk)
Graeme Rocher
Michael Yan
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`protected boolean`	`allowAbstract`
`protected String`	`artefactPath`
`protected String`	`artefactSuffix`
`protected Class<?>`	`grailsClassImpl`
`protected Class<?>`	`grailsClassType`
`protected String`	`type`

Constructor Summary

Constructors
Constructor and description
`ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix)` Adapter for the ArtefactHandler interface
`ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath)` Adapter for the ArtefactHandler interface
`ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, boolean allowAbstract)` Adapter for the ArtefactHandler interface
`ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath, boolean allowAbstract)` Adapter for the ArtefactHandler interface

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public GrailsClass`	`getArtefactForFeature(Object feature)`
	`public String`	`getPluginName()`
	`public String`	`getType()`
	`protected boolean`	`hasArtefactAnnotation(Class<?> clazz)`
	`protected boolean`	`hasArtefactAnnotation(Class<?> clazz, String value)`
	`protected boolean`	`hasArtefactAnnotation(ClassNode classNode)`
	`protected boolean`	`hasArtefactAnnotation(ClassNode classNode, String value)`
	`public void`	`initialize(ArtefactInfo artefacts)` Sets up the relationships between the domain classes, this has to be done after the initial creation to avoid looping.
	`public boolean`	`isArtefact(ClassNode classNode)` Default implementation of ArtefactHandler.isArtefact which returns true if the ClassNode is Grails resource and the name of the ClassNode ends with the artefactSuffix
	`public boolean`	`isArtefact(Class<?> clazz)`
	`protected boolean`	`isArtefactClass(ClassNode classNode)` Subclasses can override to narrow down whether the given resource is an artefact of this type.
	`public boolean`	`isArtefactClass(Class<?> clazz)`
	`public boolean`	`isArtefactGrailsClass(GrailsClass artefactGrailsClass)`
	`protected boolean`	`isValidArtefactClassNode(ClassNode classNode, int modifiers)`
	`public GrailsClass`	`newArtefactClass(Class<?> artefactClass)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - protected final boolean allowAbstract
  - protected final String artefactPath
  - protected final String artefactSuffix
  - protected final Class<?> grailsClassImpl
  - protected final Class<?> grailsClassType
  - protected final String type
- Constructor Detail
  - public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix)
    
    Adapter for the ArtefactHandler interface
    Parameters:
    type - The type of Artefact, e.g. Application, Controller
    grailsClassType - The Class Interface
    grailsClassImpl - The Class that GrailsClass to be implements
    artefactSuffix - The suffix of Artefact
  - public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath)
    
    Adapter for the ArtefactHandler interface
    Parameters:
    type - The type of Artefact, e.g. Application, Controller
    grailsClassType - The Class Interface
    grailsClassImpl - The Class that GrailsClass to be implements
    artefactSuffix - The suffix of Artefact
    artefactPath - The path of Artefact within
  - @Deprecated(since = "2024.0.0", forRemoval = true)
    public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, boolean allowAbstract)
    
    Adapter for the ArtefactHandler interface
    deprecated:
    as 2024.0.0 in favor of ArtefactHandlerAdapter(java.lang.String, java.lang.Class, java.lang.Class, java.lang.String, java.lang.String, boolean)
    
    Parameters:
    type - The type of Artefact, e.g. Application, Controller
    grailsClassType - The Class Interface
    grailsClassImpl - The Class that GrailsClass to be implements
    artefactSuffix - The suffix of Artefact
    allowAbstract - weather allow abstract or not
  - public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath, boolean allowAbstract)
    
    Adapter for the ArtefactHandler interface
    Parameters:
    type - The type of Artefact, e.g. Application, Controller
    grailsClassType - The Class Interface
    grailsClassImpl - The Class that GrailsClass to be implements
    artefactSuffix - The suffix of Artefact
    artefactPath - The path of Artefact within
    allowAbstract - weather allow abstract or not
- Method Detail
  - public GrailsClass getArtefactForFeature(Object feature)
  - public String getPluginName()
  - public String getType()
  - protected boolean hasArtefactAnnotation(Class<?> clazz)
  - protected boolean hasArtefactAnnotation(Class<?> clazz, String value)
  - protected boolean hasArtefactAnnotation(ClassNode classNode)
  - protected boolean hasArtefactAnnotation(ClassNode classNode, String value)
  - public void initialize(ArtefactInfo artefacts)
    
    Sets up the relationships between the domain classes, this has to be done after the initial creation to avoid looping.
  - @Override
    public boolean isArtefact(ClassNode classNode)
    
    Default implementation of ArtefactHandler.isArtefact which returns true if the ClassNode is Grails resource and the name of the ClassNode ends with the artefactSuffix
    Parameters:
    classNode - The ClassNode instance
    Returns:
    True if the ClassNode is an artefact of this type
  - public boolean isArtefact(Class<?> clazz)
  - protected boolean isArtefactClass(ClassNode classNode)
    
    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
    Parameters:
    classNode - The ClassNode to check
    Returns:
    True if it is a Grails artefact
  - public boolean isArtefactClass(Class<?> clazz)
    
    Checks that class's name ends in the suffix specified for this handler.
    
    Override for more complex criteria
    
    Parameters:
    clazz - The class to check
    Returns:
    true if it is an artefact of this type
  - public boolean isArtefactGrailsClass(GrailsClass artefactGrailsClass)
  - protected boolean isValidArtefactClassNode(ClassNode classNode, int modifiers)
  - public GrailsClass newArtefactClass(Class<?> artefactClass)
    
    Creates new GrailsClass derived object using the type supplied in constructor. May not perform optimally but is a convenience.
    
    Parameters:
    artefactClass - Creates a new artefact for the given class
    Returns:
    An instance of the GrailsClass interface representing the artefact

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class ArtefactHandlerAdapter

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final boolean allowAbstract

protected final String artefactPath

protected final String artefactSuffix

protected final Class<?> grailsClassImpl

protected final Class<?> grailsClassType

protected final String type

Constructor Detail

public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix)

public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath)

@Deprecated(since = "2024.0.0", forRemoval = true)
public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, boolean allowAbstract)

public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath, boolean allowAbstract)

Method Detail

public GrailsClass getArtefactForFeature(Object feature)

public String getPluginName()

public String getType()

protected boolean hasArtefactAnnotation(Class<?> clazz)

protected boolean hasArtefactAnnotation(Class<?> clazz, String value)

protected boolean hasArtefactAnnotation(ClassNode classNode)

protected boolean hasArtefactAnnotation(ClassNode classNode, String value)

public void initialize(ArtefactInfo artefacts)

@Override
public boolean isArtefact(ClassNode classNode)

public boolean isArtefact(Class<?> clazz)

protected boolean isArtefactClass(ClassNode classNode)

public boolean isArtefactClass(Class<?> clazz)

public boolean isArtefactGrailsClass(GrailsClass artefactGrailsClass)

protected boolean isValidArtefactClassNode(ClassNode classNode, int modifiers)

public GrailsClass newArtefactClass(Class<?> artefactClass)

[Java] Class ArtefactHandlerAdapter

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final boolean allowAbstract

protected final String artefactPath

protected final String artefactSuffix

protected final Class<?> grailsClassImpl

protected final Class<?> grailsClassType

protected final String type

Constructor Detail

public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix)

public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath)

@Deprecated(since = "2024.0.0", forRemoval = true)public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, boolean allowAbstract)

public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, String artefactPath, boolean allowAbstract)

Method Detail

public GrailsClass getArtefactForFeature(Object feature)

public String getPluginName()

public String getType()

protected boolean hasArtefactAnnotation(Class<?> clazz)

protected boolean hasArtefactAnnotation(Class<?> clazz, String value)

protected boolean hasArtefactAnnotation(ClassNode classNode)

protected boolean hasArtefactAnnotation(ClassNode classNode, String value)

public void initialize(ArtefactInfo artefacts)

@Overridepublic boolean isArtefact(ClassNode classNode)

public boolean isArtefact(Class<?> clazz)

protected boolean isArtefactClass(ClassNode classNode)

public boolean isArtefactClass(Class<?> clazz)

public boolean isArtefactGrailsClass(GrailsClass artefactGrailsClass)

protected boolean isValidArtefactClassNode(ClassNode classNode, int modifiers)

public GrailsClass newArtefactClass(Class<?> artefactClass)

@Deprecated(since = "2024.0.0", forRemoval = true)
public ArtefactHandlerAdapter(String type, Class<? extends GrailsClass> grailsClassType, Class<?> grailsClassImpl, String artefactSuffix, boolean allowAbstract)

@Override
public boolean isArtefact(ClassNode classNode)