Package org.nekosoft.pdffer.template

Annotation Interface PdfTemplateComponent

@Target(TYPE) @Retention(RUNTIME) public @interface PdfTemplateComponent
A stereotype annotation to mark a class as a PDF template for the PDFfer registry. PDF templates must reside in the org.nekosoft.PDFferTemplates package and must implement the PdfTemplate interface.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name of this template.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    group
    The group to which this template belongs.
    String
    scope
    The scope of this template (by default, it is "prototype", as set in the SCOPE_DEFAULT constant).

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
    BASE_PACKAGE
    The base package where all PDFfer templates reside.
    static String
    GROUP_SEPARATOR
    The separator used for composing a template path from a name and group.
    static String
    ROOT_REGISTRY
    The string representing the ROOT registry
    static String
    SCOPE_DEFAULT
    The default scope for all PDFfer templates ("prototype")
    static String
    SCOPE_SINGLETON
    The singleton scope for templates that follow a different paradigm to the standard one.

  • Field Details

    • SCOPE_DEFAULT

      static final String SCOPE_DEFAULT
      The default scope for all PDFfer templates ("prototype")
      See Also:
      Constant Field Values

    • SCOPE_SINGLETON

      static final String SCOPE_SINGLETON
      The singleton scope for templates that follow a different paradigm to the standard one. Other scopes are also possible but not checked by PDFfer, they are just passed on to the Spring framework.
      See Also:
      Constant Field Values

    • ROOT_REGISTRY

      static final String ROOT_REGISTRY
      The string representing the ROOT registry
      See Also:
      Constant Field Values

    • BASE_PACKAGE

      static final String BASE_PACKAGE
      The base package where all PDFfer templates reside.
      See Also:
      Constant Field Values

    • GROUP_SEPARATOR

      static final String GROUP_SEPARATOR
      The separator used for composing a template path from a name and group. This allows any printable character to be used as either the name or the group. Composing and de-composing template paths should always only be done with the methods provided in PdfTemplate, namely getTemplatePath and splitTemplatePath.
      See Also:
      Constant Field Values

  • Element Details

    • name

      String name
      The name of this template.
      Returns:
      the name

    • group

      String group
      The group to which this template belongs.
      Returns:
      the group
      Default:
      ""

    • scope

      String scope
      The scope of this template (by default, it is "prototype", as set in the SCOPE_DEFAULT constant).
      Returns:
      the scope
      Default:
      "prototype"