javax.persistence

Interface Tuple

Contents

  • public interface Tuple
    Interface for extracting the elements of a query result tuple.
    Since:
    Java Persistence 2.0
    See Also:
    TupleElement

    • Method Detail

      • get

        <X> X get(TupleElement<X> tupleElement)
        Get the value of the specified tuple element.
        Parameters:
        tupleElement - tuple element
        Returns:
        value of tuple element
        Throws:
        IllegalArgumentException - if tuple element does not correspond to an element in the query result tuple

      • get

        <X> X get(String alias,
          Class<X> type)
        Get the value of the tuple element to which the specified alias has been assigned.
        Parameters:
        alias - alias assigned to tuple element
        type - of the tuple element
        Returns:
        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

      • get

        Object get(String alias)
        Get the value of the tuple element to which the specified alias has been assigned.
        Parameters:
        alias - alias assigned to tuple element
        Returns:
        value of the tuple element
        Throws:
        IllegalArgumentException - if alias does not correspond to an element in the query result tuple

      • get

        <X> X get(int i,
          Class<X> type)
        Get the value of the element at the specified position in the result tuple. The first position is 0.
        Parameters:
        i - position in result tuple
        type - type of the tuple element
        Returns:
        value of the tuple element
        Throws:
        IllegalArgumentException - if i exceeds length of result tuple or element cannot be assigned to the specified type

      • get

        Object get(int i)
        Get the value of the element at the specified position in the result tuple. The first position is 0.
        Parameters:
        i - position in result tuple
        Returns:
        value of the tuple element
        Throws:
        IllegalArgumentException - if i exceeds length of result tuple

      • toArray

        Object[] toArray()
        Return the values of the result tuple elements as an array.
        Returns:
        tuple element values

      • getElements

        List<TupleElement<?>> getElements()
        Return the tuple elements.
        Returns:
        tuple elements

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/Tuple.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, Tuple (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.