Scaffold (Grails 7.1.0-SNAPSHOT)

grails.plugin.scaffolding.annotation.Scaffold

@java.lang.annotation.Retention(RetentionPolicy.RUNTIME)
@java.lang.annotation.Target(ElementType.TYPE)
public @interface Scaffold

Scaffolding annotation for Controllers and Services.

At compile-time, this annotation:

Detects whether applied to a Service or Controller
Sets appropriate parent class (with sensible defaults)
Sets the domain/entity class
Generates required constructor

Usage Examples

Services:

// Simple: domain class only (uses default GormService)
 @Scaffold(Car.class)
 class CarService {  // → extends GormService

 // Explicit: specify both class to extend and domain
 @Scaffold(value = GormService.class, domain = Car.class)
 class CarService {}  // → extends GormService

 // Alternative: domain parameter
 @Scaffold(domain = Car.class)
 class CarService {}  // → extends GormService
 }

Controllers:

// Simple: domain class only (uses default RestfulController)
 @Scaffold(Car.class)
 class CarController {  // → extends RestfulController

 // Explicit: specify both class to extend and domain
 @Scaffold(value = RestfulController.class, domain = Car.class)
 class CarController {}  // → extends RestfulController
 }

Authors:: Scott Murphy Heiberg

Since:: 5.1.0

Element Summary

Optional Element Summary
Type	Name and Description
`java.lang.Class<?>`	`domain` Domain/entity class (alternative to value).
`boolean`	`readOnly` Whether this service/controller is read-only.
`java.lang.Class<?>`	`value` Class to extend OR domain class (context-dependent).

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Element Detail
  - public java.lang.Class<?> domain
    
    Domain/entity class (alternative to value). More explicit when also specifying the class to extend.
    Examples:
```
@Scaffold(domain = Car.class)  // Uses default
 @Scaffold(value = JpaScaffoldService.class, domain = Car.class)
 
```
    Returns:
    the domain class
    Default:
    Void.class
  - public boolean readOnly
    
    Whether this service/controller is read-only. Passed to constructor of the extended class.
    For services: mutations throw ReadOnlyServiceException
    For controllers: mutation endpoints may return 405 Method Not Allowed
    Returns:
    true if read-only, false otherwise
    Default:
    false
  - public java.lang.Class<?> value
    
    Class to extend OR domain class (context-dependent).
    Interpretation:
    - If value has generics (e.g., GormService<Car>):
      - Extends GormService
      - Domain class = Car (extracted from generic)
    - If value is a scaffold class (e.g., GormService):
      - Extends value
      - Domain class = from domain() parameter
    - Otherwise (e.g., Car):
      - Domain class = value
      - Extends default for artefact type
    Returns:
    the class to extend or domain class
    Default:
    Void.class

Summary:
Optional

| Detail:
Element

[Java] Annotation Type Scaffold

Usage Examples

Services:

Controllers:

Element Summary

Inherited Methods Summary

Element Detail

public java.lang.Class<?> domain

public boolean readOnly

public java.lang.Class<?> value