Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 1.5 KB

Types.md

File metadata and controls

64 lines (47 loc) · 1.5 KB
Raw

Types

All types are handled by the TypeToken class. This allows normalizing types (int vs integer) and defining generic types. You should not have to interact with this class too often, but any type provided as a string will ultimately be routed through this class.

Resolving Types

Gson uses many methods to resolve the type of a property. In order, they are:

  • @Type annotation
  • Getter return type
  • Setter typehint
  • Getter @return annotation
  • Setter @param annotation
  • Property @var annotation
  • Property default value
  • Setter default value

If the type could not be resolved, it defaults to a wildcard type, which checks the type at runtime. If the type is ever array, Gson will check the docblocks to see if the array element types are defined.

Gson expects the generic array syntax to use square brackets after the type.

An array of integers

int[]

An array of arrays of MyClass objects

MyClass[][]

Generic Types

Generic types can be defined using the angle bracket syntax. This is common with using arrays.

Here are a few examples:

"array<int>"; // array of integers
"array<string, int>"; // a hash of integers with string keys

Generic types can also be nested

"array<array<int>>" // array of arrays of ints

Specifically for arrays, only up to two generic types are allowed. One generic type will specify the types of values in the array and two generic types will specify the types for a key and value respectively.