Package io.siddhi.doc.gen.metadata

Enum ExtensionType

  • All Implemented Interfaces:
    Serializable, Comparable<ExtensionType>
    public enum ExtensionType
extends Enum<ExtensionType>
    Enum for holding extension types supported by the doc generator and the free marker templates

    The enum values should be changed to match the names used in the documentation The enum values will affect the names used in the documentation as well as the hyperlinks

    These enum values will be passed onto the freemarker templates as a map The other members of the enum class will not be accessible from the freemarker templates These can be accesses using the EXTENSION_TYPE variable eg:- EXTENSION_TYPE.FUNCTION

    • Method Detail

      • values

        public static ExtensionType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ExtensionType c : ExtensionType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ExtensionType valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getValue

        public String getValue()