io.smallrye.graphql.api

Annotation Type ToScalar

@Retention(value=RUNTIME)
 @Target(value={TYPE,FIELD,PARAMETER,METHOD})
 @Documented
 @Experimental(value="Allow you to map to a certain scalar class. Not covered by the specification. Subject to change.")
public @interface ToScalar

Allows users to map a certain field or class to a scalar type
This is an experimental feature that might move to the spec.
Example:

 public class Profile {
     //  Map a Scalar to another existing Scalar
      @ToScalar(Scalar.Int.class)
     private Long id;
 
     // Map a POJO to another existing Scalar
      @ToScalar(Scalar.String.class)
     private IdNumber idNumber;

     // Map a List of POJOs to a list of existing Scalars
      @ToScalar(Scalar.String.class)
     private List<Website> bookmarks;

     // other getters/setters...
 }
 

Author:

Phillip Kruger (phillip.kruger@redhat.com)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends Scalar>	value

Element Detail

value

public abstract Class<? extends Scalar> value

Returns:

the scalar to use.