/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.tinkerpop.gremlin.process.traversal;
/**
* A {@link Path} may have multiple values associated with a single label.
* {@link Pop} is used to determine whether the first value, last value, or
* all values are gathered. Note that {@link Pop#mixed} will return results
* as a list if there are multiple (like {@link Pop#all}) or as a singleton
* if only one object in the path is labeled (like {@link Pop#last}).
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
public enum Pop {
/**
* The first item in an ordered collection (i.e. <code>collection[0]</code>)
*/
first,
/**
* The last item in an ordered collection (i.e. <code>collection[collection.size()-1]</code>)
*/
last,
/**
* Get all the items and return them as a list.
*/
all,
/**
* Get the items as either a list (for multiple) or an object (for singles).
*/
mixed
}