com.bric.blog

Annotation Type Blurb


  • @Retention(value=RUNTIME)
public @interface Blurb
    This is used by the WriteBlurbsJob to write a "blurb" about apps/projects.

    This was made possible with the help of this article.

    • Required Element Summary

      Required Elements

      Modifier and Type Required Element and Description
      String filename
      This is filename of the jar to be created (without the file extension).
      String releaseDate
      A short string identifying the release date of this project.
      boolean sandboxDemo
      This attribute is used to indicate that a program can run in a sandboxed environment.
      String summary
      This is one or two short paragraphs that appear below the title of this blurb.
      String title
      This is the short human-readable title of this blurb.

    • Optional Element Summary

      Optional Elements

      Modifier and Type Optional Element and Description
      String instructions
      This optional attribute is used to create the HTML page that hosts the applet of this project (if possible).
      String link
      This optional attribute links to an article (or other site) further discussing this project.
      String scrapped
      This optional attribute describes why a project was scrapped.

    • Element Detail

      • filename

        public abstract String filename
        This is filename of the jar to be created (without the file extension). For example "ColorPicker" will result in the file "ColorPicker.jar". If this returns an empty string then no jar is built.

      • title

        public abstract String title
        This is the short human-readable title of this blurb. This usually is exactly the same as a blog article's title.

      • releaseDate

        public abstract String releaseDate
        A short string identifying the release date of this project.

      • summary

        public abstract String summary
        This is one or two short paragraphs that appear below the title of this blurb. This should give a short summary/preview of the article identified in the "link" attribute.

      • sandboxDemo

        public abstract boolean sandboxDemo
        This attribute is used to indicate that a program can run in a sandboxed environment. This is used to identify jnlp/applet-compatible programs.

      • instructions

        public abstract String instructions
        This optional attribute is used to create the HTML page that hosts the applet of this project (if possible). This may be one sentence or it may be several paragraphs of HTML-formatted text.

        Although applets are indefinitely discontinued, this may be useful to keep around for other mediums someday in the future.

        Default:
        ""

      • link

        public abstract String link
        This optional attribute links to an article (or other site) further discussing this project.
        Default:
        ""

      • scrapped

        public abstract String scrapped
        This optional attribute describes why a project was scrapped. If this is an empty string then the project is not scrapped.
        Default:
        ""