Package com.dslplatform.json

Enum CompiledJson.TypeSignature

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CompiledJson.TypeSignature>
    Enclosing class:
    CompiledJson
    public static enum CompiledJson.TypeSignature
extends java.lang.Enum<CompiledJson.TypeSignature>
    Some types (abstract classes and interfaces) require additional metadata so they can be correctly deserialized. This information can be excluded by using EXCLUDE type signature. An example of valid use case for exclusion is if there is some other way of handling deserialization, or if they are never deserialized at all.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      Embed additional metadata as the first property during serialization
      EXCLUDE
      Exclude additional metadata from serialization of abstract classes and interfaces

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private TypeSignature()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CompiledJson.TypeSignature valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CompiledJson.TypeSignature[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DEFAULT

        public static final CompiledJson.TypeSignature DEFAULT
        Embed additional metadata as the first property during serialization

      • EXCLUDE

        public static final CompiledJson.TypeSignature EXCLUDE
        Exclude additional metadata from serialization of abstract classes and interfaces

    • Constructor Detail

      • TypeSignature

        private TypeSignature()

    • Method Detail

      • values

        public static CompiledJson.TypeSignature[] 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 (CompiledJson.TypeSignature c : CompiledJson.TypeSignature.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CompiledJson.TypeSignature valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null