Package 

Annotation IntDef

  • All Implemented Interfaces:
    java.lang.annotation.Annotation

    @Retention(value = )@Target(value = {}) 
    public @interface IntDef
    
                        

    Denotes that the annotated element of integer type, represents a logical type and that its value should be one of the explicitly named constants. If the IntDef#flag() attribute is set to true, multiple constants can be combined.

    Example:

     @Retention(SOURCE) @IntDef({NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS}) public @interface NavigationMode {} public static final int NAVIGATION_MODE_STANDARD = 0; public static final int NAVIGATION_MODE_LIST = 1; public static final int NAVIGATION_MODE_TABS = 2; ... public abstract void setNavigationMode(@NavigationMode int mode); @NavigationMode public abstract int getNavigationMode(); 
    For a flag, set the flag attribute:
     @IntDef( flag = true, value = {NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS}) 
    • Method Summary

      Modifier and Type Method Description
      abstract Array<int> value() Defines the allowed constants for this element
      abstract boolean flag() Defines whether the constants can be used as a flag, or just as an enum (the default)
      abstract boolean open() Whether any other values are allowed.
      • Methods inherited from class java.lang.annotation.Annotation

        annotationType, equals, hashCode, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • value

         abstract Array<int> value()

        Defines the allowed constants for this element

      • flag

         abstract boolean flag()

        Defines whether the constants can be used as a flag, or just as an enum (the default)

      • open

         abstract boolean open()

        Whether any other values are allowed. Normally this isnot the case, but this allows you to specify a set ofexpected constants, which helps code completion in the IDEand documentation generation and so on, but withoutflagging compilation warnings if other values are specified.