Type (oakgp 0.1.0-SNAPSHOT API)

java.lang.Object
- org.oakgp.Type

All Implemented Interfaces:

Comparable<Type>
```
public final class Type
extends Object
implements Comparable<Type>
```
Represents a data type.
e.g. integer, boolean, string, array, function.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Type`	`arrayType(Type t)` Returns the type associated with a `Arguments` containing elements of the specified type.
`static Type`	`bigDecimalType()` Returns the type associated with instances of `java.math.BigDecimal`.
`static Type`	`bigIntegerType()` Returns the type associated with instances of `java.math.BigInteger`.
`static Type`	`booleanArrayType()` Returns the type associated with a `Arguments` containing elements of type `booleanType()`.
`static Type`	`booleanType()` Returns the type associated with instances of `java.lang.Boolean`.
`int`	`compareTo(Type t)`
`static Type`	`doubleType()` Returns the type associated with instances of `java.lang.Double`.
`boolean`	`equals(Object o)`
`static Type`	`functionType(Type... signature)` Returns the type associated with instances of `org.oakgp.function.Function` with the specified signature.
`int`	`hashCode()`
`static Type`	`integerArrayType()` Returns the type associated with a `Arguments` containing elements of type `integerType()`.
`static Type`	`integerToBooleanFunctionType()` Returns the type associated with `org.oakgp.function.Function` instances that accept a `integerType()` and return `booleanType()`.
`static Type`	`integerType()` Returns the type associated with instances of `java.lang.Integer`.
`static boolean`	`isNullable(Type t)` Returns `true` if the given `Type` represents values that may be `null`.
`static Type`	`longType()` Returns the type associated with instances of `java.lang.Long`.
`static Type`	`nullableType(Type t)` Returns a type that represents values that can be either the given `Type` or `null`.
`static boolean`	`sameTypes(Type[] a, Type[] b)` Returns `true` if the two arrays contain the same number of elements, and all corresponding pairs of elements in the two arrays are the same.
`static Type`	`stringType()` Returns the type associated with instances of `java.lang.String`.
`String`	`toString()`
`static Type`	`type(String name)` Returns a `Type` with the given name.
`static Type`	`type(String name, Type... args)` Returns a `Type` with the given name and arguments.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - stringType
```
public static Type stringType()
```
    Returns the type associated with instances of java.lang.String.
  - booleanType
```
public static Type booleanType()
```
    Returns the type associated with instances of java.lang.Boolean.
  - integerType
```
public static Type integerType()
```
    Returns the type associated with instances of java.lang.Integer.
  - longType
```
public static Type longType()
```
    Returns the type associated with instances of java.lang.Long.
  - doubleType
```
public static Type doubleType()
```
    Returns the type associated with instances of java.lang.Double.
  - bigIntegerType
```
public static Type bigIntegerType()
```
    Returns the type associated with instances of java.math.BigInteger.
  - bigDecimalType
```
public static Type bigDecimalType()
```
    Returns the type associated with instances of java.math.BigDecimal.
  - integerToBooleanFunctionType
```
public static Type integerToBooleanFunctionType()
```
    Returns the type associated with org.oakgp.function.Function instances that accept a integerType() and return booleanType().
  - nullableType
```
public static Type nullableType(Type t)
```
    Returns a type that represents values that can be either the given Type or null.
    e.g. The result of calling nullableType(stringType()) is a type that represents values that can be either a java.lang.String or null.
    
    See Also:
    
    isNullable(Type)
  - functionType
```
public static Type functionType(Type... signature)
```
    Returns the type associated with instances of org.oakgp.function.Function with the specified signature.
    
    Parameters:
    
    signature - the function signature with the first element representing the return type and the subsequent elements representing the argument types
  - integerArrayType
```
public static Type integerArrayType()
```
    Returns the type associated with a Arguments containing elements of type integerType().
  - booleanArrayType
```
public static Type booleanArrayType()
```
    Returns the type associated with a Arguments containing elements of type booleanType().
  - arrayType
```
public static Type arrayType(Type t)
```
    Returns the type associated with a Arguments containing elements of the specified type.
  - type
```
public static Type type(String name)
```
    Returns a Type with the given name.
    If there already exists a Type with the given name and no arguments then it will be returned else a new Type with the given name and no arguments will be created and returned.
  - type
```
public static Type type(String name,
                        Type... args)
```
    Returns a Type with the given name and arguments.
    If there already exists a Type with the given name and args then it will be returned else a new Type with the given name and args will be created and returned.
  - isNullable
```
public static boolean isNullable(Type t)
```
    Returns true if the given Type represents values that may be null.
    
    See Also:
    
    nullableType(Type)
  - sameTypes
```
public static boolean sameTypes(Type[] a,
                                Type[] b)
```
    Returns true if the two arrays contain the same number of elements, and all corresponding pairs of elements in the two arrays are the same.
    Assumes no null values. Compares elements using == rather than equals(Object).
    
    Parameters:
    
    a - one array to be tested for equality
    
    b - the other array to be tested for equality
    
    Returns:
    
    true if the two arrays contain the same elements in the same order, else false
  - compareTo
```
public int compareTo(Type t)
```
    Specified by:
    
    compareTo in interface Comparable<Type>
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Type

Method Summary

Methods inherited from class java.lang.Object

Method Detail

stringType

booleanType

integerType

longType

doubleType

bigIntegerType

bigDecimalType

integerToBooleanFunctionType

nullableType

functionType

integerArrayType

booleanArrayType

arrayType

type

type

isNullable

sameTypes

compareTo

equals

hashCode

toString