Package de.craftsblock.craftsnet.api.transformers.annotations

Annotation Interface Transformer

@Repeatable(TransformerCollection.class) @Retention(RUNTIME) @Target({METHOD,TYPE}) public @interface Transformer
Annotation to mark methods or types that provide transformation functionality. This annotation specifies various attributes including the parameter name, the transformer class, and the caching behavior for the transformation operation.

Methods or types annotated with @Transformer are intended to facilitate the transformation of input parameters into desired output types. This can be particularly useful in scenarios where data needs to be converted between different formats or representations.

Since:
3.0.2-SNAPSHOT
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    parameter
    Specifies the name of the parameter to be transformed.
    Class<? extends Transformable<?,?>>
    transformer
    Specifies the class of the transformer that performs the transformation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    cacheable
    Specifies whether caching is enabled for the transformation.

  • Element Details

    • parameter

      String parameter
      Specifies the name of the parameter to be transformed.
      Returns:
      The name of the parameter.

    • transformer

      Class<? extends Transformable<?,?>> transformer
      Specifies the class of the transformer that performs the transformation. The transformer class must implement the Transformable interface.
      Returns:
      The class of the transformer.

    • cacheable

      boolean cacheable
      Specifies whether caching is enabled for the transformation. If set to true, the transformation result may be cached for subsequent invocations.
      Returns:
      True if caching is enabled, false otherwise.
      Default:
      true