Package hydra

Interface Constants

  • public interface Constants
    A module for tier-0 constants.

    • Method Summary

      Static Methods 
      Modifier and Type Method Description
      static java.lang.String fieldNameValue()
      The conventional field name used when normalizing a wrapped (newtype) value to a single-field record
      static java.lang.String ignoredVariable()
      The name used for ignored variables
      static Name keyClasses()
      Annotation key for type classes
      static Name keyDebugId()
      Annotation key for debug identifiers
      static Name keyDeprecated()
      Annotation key for deprecated markers
      static Name keyDescription()
      Annotation key for descriptions
      static Name keyExclude()
      Annotation key for exclusions
      static Name keyFirstClassType()
      A flag which tells the language coders to encode a given encoded type as a term rather than a native type
      static Name keyFreshTypeVariableCount()
      A counter for generating fresh type variable names
      static Name keyMaxLength()
      Annotation key for maximum length constraints
      static Name keyMinLength()
      Annotation key for minimum length constraints
      static Name keyPreserveFieldName()
      Annotation key for preserving field names during code generation
      static Name keyType()
      Annotation key for type information
      static java.lang.Integer maxInt32()
      The maximum value of a 32-bit integer
      static java.lang.Integer maxTraceDepth()
      A maximum depth for nested computations.
      static java.lang.String regexCamelCase()
      Regex matching a camelCase identifier: starts with a lowercase letter, then any letters or digits.
      static java.lang.String regexNamespace()
      Regex matching a Hydra namespace: dot-separated camelCase segments, each starting with a lowercase letter.
      static java.lang.String regexPackageName()
      Regex matching a Hydra package name: hyphen-separated lowercase segments, each starting with a letter.
      static java.lang.String regexPascalCase()
      Regex matching a PascalCase identifier: starts with an uppercase letter, then any letters or digits.
      static java.lang.String warningAutoGeneratedFile()
      A standard warning message for auto-generated files

    • Method Detail

      • fieldNameValue

        static java.lang.String fieldNameValue()
        The conventional field name used when normalizing a wrapped (newtype) value to a single-field record

      • ignoredVariable

        static java.lang.String ignoredVariable()
        The name used for ignored variables

      • keyClasses

        static Name keyClasses()
        Annotation key for type classes

      • keyDebugId

        static Name keyDebugId()
        Annotation key for debug identifiers

      • keyDeprecated

        static Name keyDeprecated()
        Annotation key for deprecated markers

      • keyDescription

        static Name keyDescription()
        Annotation key for descriptions

      • keyExclude

        static Name keyExclude()
        Annotation key for exclusions

      • keyFirstClassType

        static Name keyFirstClassType()
        A flag which tells the language coders to encode a given encoded type as a term rather than a native type

      • keyFreshTypeVariableCount

        static Name keyFreshTypeVariableCount()
        A counter for generating fresh type variable names

      • keyMaxLength

        static Name keyMaxLength()
        Annotation key for maximum length constraints

      • keyMinLength

        static Name keyMinLength()
        Annotation key for minimum length constraints

      • keyPreserveFieldName

        static Name keyPreserveFieldName()
        Annotation key for preserving field names during code generation

      • keyType

        static Name keyType()
        Annotation key for type information

      • maxInt32

        static java.lang.Integer maxInt32()
        The maximum value of a 32-bit integer

      • maxTraceDepth

        static java.lang.Integer maxTraceDepth()
        A maximum depth for nested computations. Currently, this is set very high because deep recursion is common in type inference over the Hydra kernel.

      • regexCamelCase

        static java.lang.String regexCamelCase()
        Regex matching a camelCase identifier: starts with a lowercase letter, then any letters or digits.

      • regexNamespace

        static java.lang.String regexNamespace()
        Regex matching a Hydra namespace: dot-separated camelCase segments, each starting with a lowercase letter.

      • regexPackageName

        static java.lang.String regexPackageName()
        Regex matching a Hydra package name: hyphen-separated lowercase segments, each starting with a letter.

      • regexPascalCase

        static java.lang.String regexPascalCase()
        Regex matching a PascalCase identifier: starts with an uppercase letter, then any letters or digits.

      • warningAutoGeneratedFile

        static java.lang.String warningAutoGeneratedFile()
        A standard warning message for auto-generated files