Interface AnnotationValueResolver

  • All Superinterfaces:
    ValueResolver<java.lang.CharSequence>
    All Known Implementing Classes:
    AnnotationValue

    public interface AnnotationValueResolver
    extends ValueResolver<java.lang.CharSequence>
    Interface for types that resolve annotation values.
    Since:
    1.0.3
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      java.util.Optional<AnnotationClassValue<?>> annotationClassValue​(java.lang.String member)
      The AnnotationClassValue instance for the given member.
      AnnotationClassValue<?>[] annotationClassValues​(java.lang.String member)
      The AnnotationClassValue instances for the given member.
      default java.util.Optional<java.lang.Boolean> booleanValue()
      The Boolean value of the given member.
      java.util.Optional<java.lang.Boolean> booleanValue​(java.lang.String member)
      The boolean value of the given member.
      default boolean[] booleanValues()
      The boolean[] value for the given member.
      boolean[] booleanValues​(java.lang.String member)
      The boolean[] value for the given member.
      default java.util.Optional<java.lang.Byte> byteValue()
      The byte value of the given member.
      java.util.Optional<java.lang.Byte> byteValue​(java.lang.String member)
      The byte value of the given member.
      default byte[] byteValues()
      The byte[] value for the given member.
      byte[] byteValues​(java.lang.String member)
      The byte[] value for the given member.
      default java.util.Optional<java.lang.Character> charValue()
      The char value of the given member.
      java.util.Optional<java.lang.Character> charValue​(java.lang.String member)
      The char value of the given member.
      default char[] charValues()
      The char[] value for the given member.
      char[] charValues​(java.lang.String member)
      The char[] value for the given member.
      default java.util.Optional<java.lang.Class<?>> classValue()
      The value of the annotation as a Class.
      java.util.Optional<java.lang.Class<?>> classValue​(java.lang.String member)
      The value of the given annotation member as a Class.
      <T> java.util.Optional<java.lang.Class<? extends T>> classValue​(java.lang.String member, java.lang.Class<T> requiredType)
      The value of the given annotation member as a Class.
      default java.lang.Class<?>[] classValues()
      The value of the annotation as a Class.
      java.lang.Class<?>[] classValues​(java.lang.String member)
      The value of the given annotation member as a Class.
      default java.util.OptionalDouble doubleValue()
      The double value of the given member.
      java.util.OptionalDouble doubleValue​(java.lang.String member)
      The double value of the given member.
      default double[] doubleValues()
      The double[] value for the given member.
      double[] doubleValues​(java.lang.String member)
      The double[] value for the given member.
      default <E extends java.lang.Enum>
      java.util.Optional<E>
      enumValue​(java.lang.Class<E> enumType)
      Return the enum value of the given member of the given enum type.
      <E extends java.lang.Enum>
      java.util.Optional<E>
      enumValue​(java.lang.String member, java.lang.Class<E> enumType)
      Return the enum value of the given member of the given enum type.
      default <E extends java.lang.Enum>
      E[]
      enumValues​(java.lang.Class<E> enumType)
      Return the enum value of the given member of the given enum type.
      <E extends java.lang.Enum>
      E[]
      enumValues​(java.lang.String member, java.lang.Class<E> enumType)
      Return the enum value of the given member of the given enum type.
      default java.util.Optional<java.lang.Float> floatValue()
      The float value of the given member.
      java.util.Optional<java.lang.Float> floatValue​(java.lang.String member)
      The double value of the given member.
      default float[] floatValues()
      The float[] value for the given member.
      float[] floatValues​(java.lang.String member)
      The float[] value for the given member.
      java.util.Map<java.lang.CharSequence,​java.lang.Object> getValues()  
      default java.util.OptionalInt intValue()
      The integer value of the given member.
      java.util.OptionalInt intValue​(java.lang.String member)
      The integer value of the given member.
      default int[] intValues()
      The int[] value for the given member.
      int[] intValues​(java.lang.String member)
      The int[] value for the given member.
      default boolean isFalse()  
      boolean isFalse​(java.lang.String member)  
      boolean isPresent​(java.lang.CharSequence member)
      Is the given member present.
      default boolean isTrue()  
      boolean isTrue​(java.lang.String member)  
      default java.util.OptionalLong longValue()
      The long value of the given member.
      java.util.OptionalLong longValue​(java.lang.String member)
      The long value of the given member.
      default long[] longValues()
      The long[] value for the given member.
      long[] longValues​(java.lang.String member)
      The long[] value for the given member.
      default java.util.Optional<java.lang.Short> shortValue()
      The integer value of the given member.
      java.util.Optional<java.lang.Short> shortValue​(java.lang.String member)
      The short value of the given member.
      default short[] shortValues()
      The short[] value for the given member.
      short[] shortValues​(java.lang.String member)
      The short[] value for the given member.
      default java.util.Optional<java.lang.String> stringValue()
      The string value of the given member.
      java.util.Optional<java.lang.String> stringValue​(java.lang.String member)
      The string value of the given member.
      default java.lang.String[] stringValues()
      The string values for the given member.
      java.lang.String[] stringValues​(java.lang.String member)
      The string values for the given member.
    • Method Detail

      • enumValue

        <E extends java.lang.Enum> java.util.Optional<E> enumValue​(@NonNull
                                                                   java.lang.String member,
                                                                   @NonNull
                                                                   java.lang.Class<E> enumType)
        Return the enum value of the given member of the given enum type.
        Type Parameters:
        E - The enum type
        Parameters:
        member - The annotation member
        enumType - The required type
        Returns:
        An Optional of the enum value
      • enumValue

        default <E extends java.lang.Enum> java.util.Optional<E> enumValue​(@NonNull
                                                                           java.lang.Class<E> enumType)
        Return the enum value of the given member of the given enum type.
        Type Parameters:
        E - The enum type
        Parameters:
        enumType - The required type
        Returns:
        An Optional of the enum value
      • enumValues

        <E extends java.lang.Enum> E[] enumValues​(@NonNull
                                                  java.lang.String member,
                                                  @NonNull
                                                  java.lang.Class<E> enumType)
        Return the enum value of the given member of the given enum type.
        Type Parameters:
        E - The enum type
        Parameters:
        member - The annotation member
        enumType - The required type
        Returns:
        An Optional of the enum value
      • enumValues

        default <E extends java.lang.Enum> E[] enumValues​(@NonNull
                                                          java.lang.Class<E> enumType)
        Return the enum value of the given member of the given enum type.
        Type Parameters:
        E - The enum type
        Parameters:
        enumType - The required type
        Returns:
        An Optional of the enum value
      • classValue

        default java.util.Optional<java.lang.Class<?>> classValue()
        The value of the annotation as a Class.
        Returns:
        An Optional class
      • classValue

        java.util.Optional<java.lang.Class<?>> classValue​(@NonNull
                                                          java.lang.String member)
        The value of the given annotation member as a Class.
        Parameters:
        member - The annotation member
        Returns:
        An Optional class
      • classValues

        @NonNull
        default java.lang.Class<?>[] classValues()
        The value of the annotation as a Class.
        Returns:
        An array of classes
      • classValues

        @NonNull
        java.lang.Class<?>[] classValues​(@NonNull
                                         java.lang.String member)
        The value of the given annotation member as a Class.
        Parameters:
        member - The annotation member
        Returns:
        An array of classes
      • annotationClassValue

        java.util.Optional<AnnotationClassValue<?>> annotationClassValue​(@NonNull
                                                                         java.lang.String member)
        The AnnotationClassValue instance for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An annotation class value
      • intValue

        java.util.OptionalInt intValue​(@NonNull
                                       java.lang.String member)
        The integer value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An OptionalInt
      • byteValue

        default java.util.Optional<java.lang.Byte> byteValue()
        The byte value of the given member.
        Returns:
        An Optional of Byte
        Since:
        3.0.0
      • byteValue

        java.util.Optional<java.lang.Byte> byteValue​(@NonNull
                                                     java.lang.String member)
        The byte value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An Optional of Byte
        Since:
        3.0.0
      • charValue

        default java.util.Optional<java.lang.Character> charValue()
        The char value of the given member.
        Returns:
        An Optional of Character
        Since:
        3.0.0
      • charValue

        java.util.Optional<java.lang.Character> charValue​(@NonNull
                                                          java.lang.String member)
        The char value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An Optional of Character
        Since:
        3.0.0
      • intValue

        default java.util.OptionalInt intValue()
        The integer value of the given member.
        Returns:
        An OptionalInt
      • longValue

        java.util.OptionalLong longValue​(@NonNull
                                         java.lang.String member)
        The long value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An OptionalLong
      • longValue

        default java.util.OptionalLong longValue()
        The long value of the given member.
        Returns:
        An OptionalLong
      • shortValue

        java.util.Optional<java.lang.Short> shortValue​(@NonNull
                                                       java.lang.String member)
        The short value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An Optional of Short
      • shortValue

        default java.util.Optional<java.lang.Short> shortValue()
        The integer value of the given member.
        Returns:
        An Optional of
      • doubleValue

        java.util.OptionalDouble doubleValue​(@NonNull
                                             java.lang.String member)
        The double value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An OptionalDouble
      • floatValue

        default java.util.Optional<java.lang.Float> floatValue()
        The float value of the given member.
        Returns:
        An Optional of Float
        Since:
        3.0.0
      • floatValue

        java.util.Optional<java.lang.Float> floatValue​(@NonNull
                                                       java.lang.String member)
        The double value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An OptionalDouble
        Since:
        3.0.0
      • doubleValue

        default java.util.OptionalDouble doubleValue()
        The double value of the given member.
        Returns:
        An OptionalDouble
      • stringValue

        java.util.Optional<java.lang.String> stringValue​(@NonNull
                                                         java.lang.String member)
        The string value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An OptionalInt
      • stringValue

        default java.util.Optional<java.lang.String> stringValue()
        The string value of the given member.
        Returns:
        An OptionalInt
      • booleanValue

        java.util.Optional<java.lang.Boolean> booleanValue​(@NonNull
                                                           java.lang.String member)
        The boolean value of the given member.
        Parameters:
        member - The annotation member
        Returns:
        An Optional boolean
      • booleanValue

        default java.util.Optional<java.lang.Boolean> booleanValue()
        The Boolean value of the given member.
        Returns:
        An Optional boolean
      • stringValues

        @NonNull
        java.lang.String[] stringValues​(@NonNull
                                        java.lang.String member)
        The string values for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of String
      • stringValues

        @NonNull
        default java.lang.String[] stringValues()
        The string values for the given member.
        Returns:
        An array of String
      • booleanValues

        @NonNull
        boolean[] booleanValues​(@NonNull
                                java.lang.String member)
        The boolean[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of boolean
        Since:
        3.0.0
      • booleanValues

        @NonNull
        default boolean[] booleanValues()
        The boolean[] value for the given member.
        Returns:
        An array of boolean
        Since:
        3.0.0
      • byteValues

        @NonNull
        byte[] byteValues​(@NonNull
                          java.lang.String member)
        The byte[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of byte
        Since:
        3.0.0
      • byteValues

        @NonNull
        default byte[] byteValues()
        The byte[] value for the given member.
        Returns:
        An array of byte
        Since:
        3.0.0
      • charValues

        @NonNull
        char[] charValues​(@NonNull
                          java.lang.String member)
        The char[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of char
        Since:
        3.0.0
      • charValues

        @NonNull
        default char[] charValues()
        The char[] value for the given member.
        Returns:
        An array of char
        Since:
        3.0.0
      • intValues

        @NonNull
        int[] intValues​(@NonNull
                        java.lang.String member)
        The int[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of int
        Since:
        3.0.0
      • intValues

        @NonNull
        default int[] intValues()
        The int[] value for the given member.
        Returns:
        An array of int
        Since:
        3.0.0
      • doubleValues

        @NonNull
        double[] doubleValues​(@NonNull
                              java.lang.String member)
        The double[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of double
        Since:
        3.0.0
      • doubleValues

        @NonNull
        default double[] doubleValues()
        The double[] value for the given member.
        Returns:
        An array of double
        Since:
        3.0.0
      • longValues

        @NonNull
        long[] longValues​(@NonNull
                          java.lang.String member)
        The long[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of long
        Since:
        3.0.0
      • longValues

        @NonNull
        default long[] longValues()
        The long[] value for the given member.
        Returns:
        An array of long
        Since:
        3.0.0
      • floatValues

        @NonNull
        float[] floatValues​(@NonNull
                            java.lang.String member)
        The float[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of float
        Since:
        3.0.0
      • floatValues

        @NonNull
        default float[] floatValues()
        The float[] value for the given member.
        Returns:
        An array of float
        Since:
        3.0.0
      • shortValues

        @NonNull
        short[] shortValues​(@NonNull
                            java.lang.String member)
        The short[] value for the given member.
        Parameters:
        member - The annotation member
        Returns:
        An array of short
        Since:
        3.0.0
      • shortValues

        @NonNull
        default short[] shortValues()
        The short[] value for the given member.
        Returns:
        An array of short
        Since:
        3.0.0
      • isPresent

        boolean isPresent​(java.lang.CharSequence member)
        Is the given member present.
        Parameters:
        member - The member
        Returns:
        True if it is
      • isTrue

        default boolean isTrue()
        Returns:
        Is the value of the annotation true.
      • isTrue

        boolean isTrue​(java.lang.String member)
        Parameters:
        member - The member
        Returns:
        Is the value of the annotation true.
      • isFalse

        default boolean isFalse()
        Returns:
        Is the value of the annotation true.
      • isFalse

        boolean isFalse​(java.lang.String member)
        Parameters:
        member - The member
        Returns:
        Is the value of the annotation true.
      • classValue

        <T> java.util.Optional<java.lang.Class<? extends T>> classValue​(@NonNull
                                                                        java.lang.String member,
                                                                        @NonNull
                                                                        java.lang.Class<T> requiredType)
        The value of the given annotation member as a Class.
        Type Parameters:
        T - The required type
        Parameters:
        member - The annotation member
        requiredType - The required type
        Returns:
        An Optional class
      • getValues

        @NonNull
        java.util.Map<java.lang.CharSequence,​java.lang.Object> getValues()
        Returns:
        The attribute values