Primitive (Apache Calcite linq4j API)

java.lang.Object
- java.lang.Enum<Primitive>
- - org.apache.calcite.linq4j.tree.Primitive

All Implemented Interfaces:

Serializable, Comparable<Primitive>
```
public enum Primitive
extends Enum<Primitive>
```
Enumeration of Java's primitive types.
There are fields for the native class (e.g. int, also known as Integer.TYPE) and the boxing class (e.g. Integer).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Primitive.Flavor` Whether a type is primitive (e.g.
`static interface`	`Primitive.Sink` A place to send a value.
`static interface`	`Primitive.Source` A place from which to read a value.

Enum Constant Summary

Enum Constants
Enum Constant and Description

BOOLEAN

BYTE

CHAR

DOUBLE

FLOAT

INT

LONG

OTHER

SHORT

VOID

Enum Constants
Enum Constant and Description
`BOOLEAN`
`BYTE`
`CHAR`
`DOUBLE`
`FLOAT`
`INT`
`LONG`
`OTHER`
`SHORT`
`VOID`

Field Summary

Fields
Modifier and Type	Field and Description
`@Nullable Class`	`boxClass`
`@Nullable String`	`boxName`
`@Nullable Object`	`defaultValue` The default value of this primitive class.
`@Nullable Object`	`max` The maximum value of this primitive class.
`@Nullable Object`	`maxNegative` The largest value that is less than zero.
`@Nullable Object`	`min` The minimum value of this primitive class.
`@Nullable Object`	`minPositive` The smallest value that is greater than zero.
`@Nullable Class`	`primitiveClass`
`@Nullable String`	`primitiveName`
`int`	`size` The size of a value of this type, in bits.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`@Nullable Object`	`arrayItem(Object dataSet, int ordinal)` Gets an item from an array.
`void`	`arrayItem(Object dataSet, int ordinal, Primitive.Sink sink)` Sends to a sink an from an array.
`void`	`arrayItem(Primitive.Source source, Object dataSet, int ordinal)` Reads value from a source into an array.
`String`	`arrayToString(Object array)` Converts an array to a string.
`static List<Boolean>`	`asList(boolean[] elements)` Adapts an array of `boolean` into a `List` of `Boolean`.
`static List<Byte>`	`asList(byte[] elements)` Adapts an array of `byte` into a `List` of `Byte`.
`static List<Character>`	`asList(char[] elements)` Adapts an array of `char` into a `List` of `Character`.
`static List<Double>`	`asList(double[] elements)` Adapts an array of `double` into a `List` of `Double`.
`static List<Float>`	`asList(float[] elements)` Adapts an array of `float` into a `List` of `Float`.
`static List<Integer>`	`asList(int[] elements)` Adapts an array of `int` into a `List` of `Integer`.
`static List<Long>`	`asList(long[] elements)` Adapts an array of `long` into a `List` of `Long`.
`static List<?>`	`asList(Object array)` Adapts a primitive array into a `List`.
`static List<Short>`	`asList(short[] elements)` Adapts an array of `short` into a `List` of `Short`.
`boolean`	`assignableFrom(Primitive primitive)`
`static Class`	`box(Class type)` Converts a primitive class to a boxed class; returns other classes unchanged.
`static Type`	`box(Type type)` Converts a primitive type to a boxed type; returns other types unchanged.
`static Primitive.Flavor`	`flavor(Type type)` Returns whether this type is a primitive, box or other type.
`Class<?>`	`getBoxClass()`
`String`	`getBoxName()`
`Class<?>`	`getPrimitiveClass()`
`String`	`getPrimitiveName()`
`static boolean`	`is(Type type)` Returns whether a given type is primitive.
`static boolean`	`isBox(Type type)` Returns whether a given type is a box type (e.g.
`boolean`	`isFixedNumeric()` Returns whether this Primitive is a fixed-point numeric type.
`boolean`	`isNumeric()` Returns whether this Primitive is a numeric type.
`void`	`jdbc(ResultSet resultSet, int i, Primitive.Sink sink)` Sends to a sink a value from a given column in a JDBC result set.
`@Nullable Object`	`jdbcGet(ResultSet resultSet, int i)` Gets a value from a given column in a JDBC result set.
`Number`	`number(Number value)` Creates a number value of this primitive's box type.
`static @Nullable Primitive`	`of(Type type)` Returns the Primitive object for a given primitive class.
`static @Nullable Primitive`	`ofBox(Type type)` Returns the Primitive object for a given boxing class.
`static @Nullable Primitive`	`ofBoxOr(Type type)` Returns the Primitive object for a given primitive or boxing class.
`Object`	`parse(String stringValue)` Calls the appropriate `valueOf(String)` method.
`Object`	`permute(Object array, int[] sources)` Permutes an array.
`void`	`send(Field field, Object o, Primitive.Sink sink)` Sends a field value to a sink.
`void`	`send(Primitive.Source source, Primitive.Sink sink)` Sends a value from a source to a sink.
`void`	`sortArray(Object array)` Sorts an array of this primitive type.
`void`	`sortArray(Object array, int fromIndex, int toIndex)` Sorts a specified range of an array of this primitive type.
`Object`	`toArray(Collection collection)` Converts a collection of boxed primitives into an array of primitives.
`Object`	`toArray2(Collection<Number> collection)` Converts a collection of `Number` to a primitive array.
`static Class`	`unbox(Class type)` Converts a boxed class to a primitive class; returns other types unchanged.
`static Type`	`unbox(Type type)` Converts a boxed type to a primitive type; returns other types unchanged.
`static Primitive`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Primitive[]`	`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
  - BOOLEAN
```
public static final Primitive BOOLEAN
```
  - BYTE
```
public static final Primitive BYTE
```
  - CHAR
```
public static final Primitive CHAR
```
  - SHORT
```
public static final Primitive SHORT
```
  - INT
```
public static final Primitive INT
```
  - LONG
```
public static final Primitive LONG
```
  - FLOAT
```
public static final Primitive FLOAT
```
  - DOUBLE
```
public static final Primitive DOUBLE
```
  - VOID
```
public static final Primitive VOID
```
  - OTHER
```
public static final Primitive OTHER
```
- Field Detail
  - primitiveClass
```
public final @Nullable Class primitiveClass
```
  - boxClass
```
public final @Nullable Class boxClass
```
  - primitiveName
```
public final @Nullable String primitiveName
```
  - boxName
```
public final @Nullable String boxName
```
  - defaultValue
```
public final @Nullable Object defaultValue
```
    The default value of this primitive class. This is the value taken by uninitialized fields, for instance; 0 for int, false for boolean, etc.
  - min
```
public final @Nullable Object min
```
    The minimum value of this primitive class.
  - maxNegative
```
public final @Nullable Object maxNegative
```
    The largest value that is less than zero. Null if not applicable for this type.
  - minPositive
```
public final @Nullable Object minPositive
```
    The smallest value that is greater than zero. Null if not applicable for this type.
  - max
```
public final @Nullable Object max
```
    The maximum value of this primitive class.
  - size
```
public final int size
```
    The size of a value of this type, in bits. Null if not applicable for this type.
- Method Detail
  - values
```
public static Primitive[] 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 (Primitive c : Primitive.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Primitive valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - of
```
public static @Nullable Primitive of(Type type)
```
    Returns the Primitive object for a given primitive class.
    For example, of(long.class) returns LONG. Returns null when applied to a boxing or other class; for example of(Long.class) and of(String.class) return null.
  - ofBox
```
public static @Nullable Primitive ofBox(Type type)
```
    Returns the Primitive object for a given boxing class.
    For example, ofBox(java.util.Long.class) returns LONG.
  - ofBoxOr
```
public static @Nullable Primitive ofBoxOr(Type type)
```
    Returns the Primitive object for a given primitive or boxing class.
    For example, ofBoxOr(Long.class) and ofBoxOr(long.class) both return LONG.
  - is
```
public static boolean is(Type type)
```
    Returns whether a given type is primitive.
  - isBox
```
public static boolean isBox(Type type)
```
    Returns whether a given type is a box type (e.g. Integer).
  - flavor
```
public static Primitive.Flavor flavor(Type type)
```
    Returns whether this type is a primitive, box or other type. Useful for switch statements.
  - isNumeric
```
public boolean isNumeric()
```
    Returns whether this Primitive is a numeric type.
  - isFixedNumeric
```
public boolean isFixedNumeric()
```
    Returns whether this Primitive is a fixed-point numeric type.
  - box
```
public static Type box(Type type)
```
    Converts a primitive type to a boxed type; returns other types unchanged.
  - box
```
public static Class box(Class type)
```
    Converts a primitive class to a boxed class; returns other classes unchanged.
  - unbox
```
public static Type unbox(Type type)
```
    Converts a boxed type to a primitive type; returns other types unchanged.
  - unbox
```
public static Class unbox(Class type)
```
    Converts a boxed class to a primitive class; returns other types unchanged.
  - getPrimitiveClass
```
@API(since="1.27",
     status=EXPERIMENTAL)
public Class<?> getPrimitiveClass()
```
  - getBoxClass
```
@API(since="1.27",
     status=EXPERIMENTAL)
public Class<?> getBoxClass()
```
  - getPrimitiveName
```
@API(since="1.27",
     status=EXPERIMENTAL)
public String getPrimitiveName()
```
  - getBoxName
```
@API(since="1.27",
     status=EXPERIMENTAL)
public String getBoxName()
```
  - asList
```
public static List<?> asList(Object array)
```
    Adapts a primitive array into a List. For example, asList(new double[2]) returns a List<Double>.
  - asList
```
public static List<Boolean> asList(boolean[] elements)
```
    Adapts an array of boolean into a List of Boolean.
  - asList
```
public static List<Byte> asList(byte[] elements)
```
    Adapts an array of byte into a List of Byte.
  - asList
```
public static List<Character> asList(char[] elements)
```
    Adapts an array of char into a List of Character.
  - asList
```
public static List<Short> asList(short[] elements)
```
    Adapts an array of short into a List of Short.
  - asList
```
public static List<Integer> asList(int[] elements)
```
    Adapts an array of int into a List of Integer.
  - asList
```
public static List<Long> asList(long[] elements)
```
    Adapts an array of long into a List of Long.
  - asList
```
public static List<Float> asList(float[] elements)
```
    Adapts an array of float into a List of Float.
  - asList
```
public static List<Double> asList(double[] elements)
```
    Adapts an array of double into a List of Double.
  - toArray
```
public Object toArray(Collection collection)
```
    Converts a collection of boxed primitives into an array of primitives.
    
    Parameters:
    
    collection - Collection of boxed primitives
    
    Returns:
    
    array of primitives
    
    Throws:
    
    ClassCastException - if any element is not of the box type
    
    NullPointerException - if any element is null
  - toArray2
```
public Object toArray2(Collection<Number> collection)
```
    Converts a collection of Number to a primitive array.
  - permute
```
public Object permute(Object array,
                      int[] sources)
```
    Permutes an array.
  - arrayToString
```
public String arrayToString(Object array)
```
    Converts an array to a string.
    
    Parameters:
    
    array - Array of this primitive type
    
    Returns:
    
    String representation of array
  - sortArray
```
public void sortArray(Object array)
```
    Sorts an array of this primitive type.
    
    Parameters:
    
    array - Array of this primitive type
  - sortArray
```
public void sortArray(Object array,
                      int fromIndex,
                      int toIndex)
```
    Sorts a specified range of an array of this primitive type.
    
    Parameters:
    
    array - Array of this primitive type
    
    fromIndex - the index of the first element, inclusive, to be sorted
    
    toIndex - the index of the last element, exclusive, to be sorted
  - send
```
public void send(Field field,
                 Object o,
                 Primitive.Sink sink)
          throws IllegalAccessException
```
    Sends a field value to a sink.
    
    Throws:
    
    IllegalAccessException
  - arrayItem
```
public @Nullable Object arrayItem(Object dataSet,
                                  int ordinal)
```
    Gets an item from an array.
  - arrayItem
```
public void arrayItem(Primitive.Source source,
                      Object dataSet,
                      int ordinal)
```
    Reads value from a source into an array.
  - arrayItem
```
public void arrayItem(Object dataSet,
                      int ordinal,
                      Primitive.Sink sink)
```
    Sends to a sink an from an array.
  - jdbcGet
```
public @Nullable Object jdbcGet(ResultSet resultSet,
                                int i)
                         throws SQLException
```
    Gets a value from a given column in a JDBC result set.
    
    Parameters:
    
    resultSet - Result set
    
    i - Ordinal of column (1-based, per JDBC)
    
    Throws:
    
    SQLException
  - jdbc
```
public void jdbc(ResultSet resultSet,
                 int i,
                 Primitive.Sink sink)
          throws SQLException
```
    Sends to a sink a value from a given column in a JDBC result set.
    
    Parameters:
    
    resultSet - Result set
    
    i - Ordinal of column (1-based, per JDBC)
    
    sink - Sink
    
    Throws:
    
    SQLException
  - send
```
public void send(Primitive.Source source,
                 Primitive.Sink sink)
```
    Sends a value from a source to a sink.
  - parse
```
public Object parse(String stringValue)
```
    Calls the appropriate valueOf(String) method.
  - assignableFrom
```
public boolean assignableFrom(Primitive primitive)
```
  - number
```
public Number number(Number value)
```
    Creates a number value of this primitive's box type. For example, SHORT.number(Integer(0)) will return Short(0).

Enum Primitive

Nested Class Summary

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BOOLEAN

BYTE

CHAR

SHORT

INT

LONG

FLOAT

DOUBLE

VOID

OTHER

Field Detail

primitiveClass

boxClass

primitiveName

boxName

defaultValue

min

maxNegative

minPositive

max

size

Method Detail

values

valueOf

of

ofBox

ofBoxOr

is

isBox

flavor

isNumeric

isFixedNumeric

box

box

unbox

unbox

getPrimitiveClass

getBoxClass

getPrimitiveName

getBoxName

asList

asList

asList

asList

asList

asList

asList

asList

asList

toArray

toArray2

permute

arrayToString

sortArray

sortArray

send

arrayItem

arrayItem

arrayItem

jdbcGet

jdbc

send

parse

assignableFrom

number