javax.persistence.TupleElement Maven / Gradle / Ivy

Go to download
/*
 * 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;

/**
 * The TupleElement interface defines an element that is returned in
 * a query result tuple.
 *
 * @param  the type of the element
 * @see Tuple
 * @since Java Persistence 2.0
 */
public interface TupleElement {
  /**
   * Return the Java type of the tuple element.
   *
   * @return the Java type of the tuple element
   */
  Class getJavaType();

  /**
   * Return the alias assigned to the tuple element or null,
   * if no alias has been assigned.
   *
   * @return alias
   */
  String getAlias();
}