Package org.apache.tinkerpop.gremlin.process.traversal

Enum Class Pop

java.lang.Object
java.lang.Enum<Pop>
org.apache.tinkerpop.gremlin.process.traversal.Pop
All Implemented Interfaces:
Serializable, Comparable<Pop>, Constable
public enum Pop extends Enum<Pop>
A Path may have multiple values associated with a single label. Pop is used to determine whether the first value, last value, or all values are gathered. Note that mixed will return results as a list if there are multiple (like all) or as a singleton if only one object in the path is labeled (like last).
Author:
Marko A. Rodriguez (http://markorodriguez.com)

  • Enum Constant Details

    • first

      public static final Pop first
      The first item in an ordered collection (i.e. collection[0]).
      Since:
      3.0.0-incubating

    • last

      public static final Pop last
      The last item in an ordered collection (i.e. collection[collection.size()-1]).
      Since:
      3.0.0-incubating

    • all

      public static final Pop all
      Get all the items and return them as a list.
      Since:
      3.0.0-incubating

    • mixed

      public static final Pop mixed
      Get the items as either a list (for multiple) or an object (for singles).

  • Method Details

    • values

      public static Pop[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Pop valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null