Package grails.core

Interface ArtefactInfo

  • All Known Implementing Classes:
    DefaultArtefactInfo
    public interface ArtefactInfo
    Holder for all the class-related info and structures relating to an Artefact.
    Since:
    1.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Class[] getClasses()
      Gets you the array of all artefact Class(es), the original classes loaded that represent the artefacts.
      java.util.Map getClassesByName()
      Gets you the unmodifiable Map of all artefact Class(es), the actual classes implementing the artefact.
      GrailsClass getGrailsClass​(java.lang.String name)
      Retrieves the GrailsClass representing a named artefact.
      GrailsClass getGrailsClassByLogicalPropertyName​(java.lang.String logicalName)
      Retrieves a Grails class by its logical property name.
      GrailsClass[] getGrailsClasses()
      Gets you the array of all artefact GrailsClass(es), the classes used to track information about the artefact.
      java.util.Map getGrailsClassesByName()
      Gets you the unmodifiable Map of all artefact GrailsClass(es), the classes that store extra state relating to the artefact.

    • Method Detail

      • getClasses

        java.lang.Class[] getClasses()
        Gets you the array of all artefact Class(es), the original classes loaded that represent the artefacts.
        Returns:
        The array, which may be empty but never null.

      • getGrailsClasses

        GrailsClass[] getGrailsClasses()
        Gets you the array of all artefact GrailsClass(es), the classes used to track information about the artefact.
        Returns:
        The array, which may be empty but never null.

      • getClassesByName

        java.util.Map getClassesByName()
        Gets you the unmodifiable Map of all artefact Class(es), the actual classes implementing the artefact.

        The Map is keyed by class name, i.e. "BookController"

        Returns:
        The Map, which may be empty but never null.

      • getGrailsClassesByName

        java.util.Map getGrailsClassesByName()

        Gets you the unmodifiable Map of all artefact GrailsClass(es), the classes that store extra state relating to the artefact.

        The Map is keyed by class name, i.e. "BookController"

        Returns:
        The Map, which may be empty but never null.

      • getGrailsClass

        GrailsClass getGrailsClass​(java.lang.String name)

        Retrieves the GrailsClass representing a named artefact.

        From the GrailsClass you can get to the original artefact Class using getClazz().

        Parameters:
        name - The name of the artefact, i.e. "BookController"
        Returns:
        The Map, which may be empty but never null.

      • getGrailsClassByLogicalPropertyName

        GrailsClass getGrailsClassByLogicalPropertyName​(java.lang.String logicalName)
        Retrieves a Grails class by its logical property name. For example "BookController" would be "book".
        Parameters:
        logicalName - The logical name
        Returns:
        A GrailsClass or null