Package com.ibm.wsspi.anno.classsource

Interface ClassSource_Options

public interface ClassSource_Options
Options for class sources. See ClassSource_Factory.createAggregateClassSource(String, ClassSource_Options). Only one option is supported: Whether Jandex indexes are to be used when populating annotations targets tables. That is, when processing a non-aggregate class source, when Jandex use is enabled, steps to populate annotation targets first check for a Jandex index in a standard location. That is 'META-INF/jandex.idx'. An adjustment is made when scanning a container mapped class source: If the container is not a root container and has the relative path 'WEB-INF/classes', the location of the Jandex index is adjusted to "../../META-INF/jandex.idx', which shifts the location outside of the immediate container and back to being relative to the container root.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getIsSetUseJandex()
    Tell if 'use jandex' is set.
    boolean
    getUseJandex()
    Answer the 'use jandex' value.
    boolean
    getUseJandexDefault()
    Answer the default 'use jandex' setting.
    void
    setUseJandex(boolean useJandex)
    Set the 'use jandex' value.
    void
    unsetUseJandex()
    Unset the 'use jandex' value.

  • Method Details

    • getUseJandexDefault

      boolean getUseJandexDefault()
      Answer the default 'use jandex' setting.
      Returns:
      The default 'use jandex' setting.

    • getIsSetUseJandex

      boolean getIsSetUseJandex()
      Tell if 'use jandex' is set. If unset, the default value is returned from getUseJandex().
      Returns:
      Whether 'use jandex' is set.

    • setUseJandex

      void setUseJandex(boolean useJandex)
      Set the 'use jandex' value.
      Parameters:
      useJandex - The value to set to 'use jandex'.

    • unsetUseJandex

      void unsetUseJandex()
      Unset the 'use jandex' value.

    • getUseJandex

      boolean getUseJandex()
      Answer the 'use jandex' value. If unset, the default value will be returned.
      Returns:
      The 'use jandex' value.