Class Constants

java.lang.Object
net.darkhax.curseforgegradle.Constants

public class Constants extends Object
This class contains all constants repeatedly used by the plugin. The majority of these properties are used to validate known values for enum-like properties.
  • Field Details

    • GSON

      public static final com.google.gson.Gson GSON
      A GSON instance that is used by the plugin to serialize objects to JSON. This is primarily used to generate API request bodies and parse responses from the CurseForge API.
    • PRETTY_GSON

      public static final com.google.gson.Gson PRETTY_GSON
      A GSON instance that is used by the plugin to serialize objects to JSON for use in more readable logging.
    • RELATION_EMBEDDED

      public static final String RELATION_EMBEDDED
      The value for an embedded relationship. This is used when the files you publish contain an embedded version of the other project.
      See Also:
    • RELATION_INCOMPATIBLE

      public static final String RELATION_INCOMPATIBLE
      The value for an incompatible relationship. This is used when the other project will not work if installed in the same game instance as your own project.
      See Also:
    • RELATION_OPTIONAL

      public static final String RELATION_OPTIONAL
      The value for an optional relationship. This is used when you have special support specifically for another project but the other project is not required.
      See Also:
    • RELATION_REQUIRED

      public static final String RELATION_REQUIRED
      The value for a required relationship. This is used when your file requires a file from the other project and will not work without it.
      See Also:
    • RELATION_TOOL

      public static final String RELATION_TOOL
      The value for a tool relationship. Nobody really knows what this does.
      See Also:
    • VALID_RELATION_TYPES

      public static final Set<String> VALID_RELATION_TYPES
      An immutable set of all relation types that are known to be valid. This is often used to validate user input.
    • CHANGELOG_TEXT

      public static final String CHANGELOG_TEXT
      The value for a plain text changelog. No special formatting is applied when this is used.
      See Also:
    • CHANGELOG_HTML

      public static final String CHANGELOG_HTML
      The value for an HTML changelog. Only a subset of HTML is supported.
      See Also:
    • CHANGELOG_MARKDOWN

      public static final String CHANGELOG_MARKDOWN
      The value for a Markdown changelog. Only a subset of markdown is supported.
      See Also:
    • VALID_CHANGELOG_TYPES

      public static final Set<String> VALID_CHANGELOG_TYPES
      An immutable set of all changelog types known to be valid. This is often used to validate user input.
    • RELEASE_TYPE_ALPHA

      public static final String RELEASE_TYPE_ALPHA
      The value for an alpha release. These files are often hidden from certain API responses and user views.
      See Also:
    • RELEASE_TYPE_BETA

      public static final String RELEASE_TYPE_BETA
      The value for a beta release. These files are often hidden from certain API responses and user views.
      See Also:
    • RELEASE_TYPE_RELEASE

      public static final String RELEASE_TYPE_RELEASE
      The value for a full release. These are often considered stable/promoted builds.
      See Also:
    • VALID_RELEASE_TYPES

      public static final Set<String> VALID_RELEASE_TYPES
      An immutable set of all release types known to be valid. This is often used to validate user input.
  • Constructor Details

    • Constants

      public Constants()