Skip to content

jmarkovic/SupportAnnotationExamples

Repository files navigation

SupportAnnotationExamples

Examples for many available annotations in Support Annotation package, complete with comments and javadoc explaining how to use them and when.

Sources

Examples have been compiled from

Structure

Examples of how to use support annotations are all created inside Utility.java class. Each topic is written inside a region block which should make it more organized. Each method has javadoc written to explain what should be expected with real implementation.

Examples of how support annotations work is done in MainActivity.java . Similar to how code is organized in Utility.java, different topics are written inside region blocks. Normal comments are used to explain each step.

Almost all annotations are used

List of annotations used in these examples:

  • Nullable
  • NonNull
  • StringRes
  • ColorRes
  • IdRes
  • MainThread
  • UiThread
  • WorkerThread
  • BinderThread
  • ColorInt
  • IntRange
  • FloatRange
  • Size
  • RequiresPermission
  • CallSuper
  • CheckResult
  • VisibleForTesting
  • Keep

Annotations that have no example:

  • Other (Resource)Def annotations - since use case of any resource annotation is the same, not all have been used for an example.
  • IntDef*
  • StringDef*
  • IntDef and StringDef are a huge topic for them selves. They help enforce type safety on method parameters and return values that require an int or String type, similar to resource annotations. Unlike resource annotations, user of support annotations defines a definite list of constant values that can be used. These are more commonly known as MagicConstants.

About

Examples for many available annotations in Support Annotation package, complete with comments and javadoc explaining how to use them and when.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages