org.neo4j.bolt.v1.packstream.PackType Maven / Gradle / Ivy

/*
 * Copyright (c) 2002-2017 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.bolt.v1.packstream;

/**
 * These are the primitive types that PackStream can represent. They map to the non-graph primitives of the Neo4j
 * type system. Graph primitives and rich composite types are represented as {@link #STRUCT}.
 */
public enum PackType
{
    /** The absence of a value */
    NULL,
    /** You know what this is */
    BOOLEAN,
    /** 64-bit signed integer */
    INTEGER,
    /** 64-bit floating point number */
    FLOAT,
    /** Binary data */
    BYTES,
    /** Unicode string */
    STRING,
    /** Sequence of zero or more values */
    LIST,
    /** Sequence of zero or more key/value pairs, keys are unique */
    MAP,
    /** A composite data structure, made up of zero or more packstream values and a type signature. */
    STRUCT,
    /** A marker that denotes the end of a streamed value */
    END_OF_STREAM,
    /** Undefined type, reserved for future use */
    RESERVED
}