javax.persistence.Tuple Maven / Gradle / Ivy

Go to download
package javax.persistence;

import java.util.List;

/**
 * Interface for extracting the elements of a query result tuple.
 */
public interface Tuple {
	/**
	 * 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);

	/**
	 * 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
	 * @param 
	 *            the type of the tuple element
	 * @return value of the tuple element
	 * @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 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 tuple element to which the specified alias has been assigned.
	 * 
	 * @param alias
	 *            alias assigned to tuple element
	 * @param type
	 *            of the tuple element
	 * @param 
	 *            the type of the tuple element
	 * @return value of the tuple element
	 * @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 specified tuple element.
	 * 
	 * @param tupleElement
	 *            tuple element
	 * @param 
	 *            the type of the tuple element
	 * @return value of tuple element
	 * @throws IllegalArgumentException
	 *             if tuple element does not correspond to an element in the query result tuple
	 */
	 X get(TupleElement tupleElement);

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

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