javax.persistence.Tuple Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javax.persistence Show documentation

The Java Persistence API (JPA) : a standard interface-based Java model abstraction of persistence, developed by the JCP.

There is a newer version: 2.2.4

Show newest version

/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence;

import java.util.List;

/**
 * Interface for extracting the elements of a query result tuple.
 * @see TupleElement
 * @since Java Persistence 2.0
 */
public interface Tuple
{
    /**
     * Get the value of the specified tuple element.
     * @param tupleElement tuple element
     * @return value of tuple element
     * @param  Type
     * @throws IllegalArgumentException if tuple element does not correspond to an element in the query result
     * tuple
     */
     X get(TupleElement tupleElement);

    /**
     * Get the value of the tuple element to which the specified alias has been assigned.
     * @param alias alias assigned to tuple element
     * @param type of the tuple element
     * @return value of the tuple element
     * @param  Type
     * @throws IllegalArgumentException if alias does not correspond to an element in the query result tuple or
     * element cannot be assigned to the specified type
     */
     X get(String alias, Class type);

    /**
     * Get the value of the tuple element to which the specified alias has been assigned.
     * @param alias alias assigned to tuple element
     * @return value of the tuple element
     * @throws IllegalArgumentException if alias does not correspond to an element in the query result tuple
     */
    Object get(String alias);

    /**
     * Get the value of the element at the specified position in the result tuple. The first position is 0.
     * @param i position in result tuple
     * @param type type of the tuple element
     * @return value of the tuple element
     * @param  Type
     * @throws IllegalArgumentException if i exceeds length of result tuple or element cannot be assigned to
     * the specified type
     */
     X get(int i, Class type);

    /**
     * Get the value of the element at the specified position in the result tuple. The first position is 0.
     * @param i position in result tuple
     * @return value of the tuple element
     * @throws IllegalArgumentException if i exceeds length of result tuple
     */
    Object get(int i);

    /**
     * Return the values of the result tuple elements as an array.
     * @return tuple element values
     */
    Object[] toArray();

    /**
     * Return the tuple elements.
     * @return tuple elements
     */
    List> getElements();
}