001/*
002 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
003 *
004 * This program and the accompanying materials are made available under the
005 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
006 * which accompanies this distribution.  The Eclipse Public License is available
007 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
008 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
009 */
010package javax.persistence;
011
012import java.lang.annotation.Retention;
013import java.lang.annotation.Target;
014
015import static java.lang.annotation.RetentionPolicy.RUNTIME;
016
017/**
018 * Used to supply a query property or hint to the {@link NamedQuery} or {@link
019 * NamedNativeQuery} annotation.
020 * <p>
021 * <p> Vendor-specific hints that are not recognized by a provider are ignored.
022 *
023 * @since Java Persistence 1.0
024 */
025@Target({})
026@Retention(RUNTIME)
027public @interface QueryHint {
028  /**
029   * Name of the hint.
030   *
031   * @return name
032   */
033  String name();
034
035  /**
036   * Value of the hint.
037   *
038   * @return the hint
039   */
040  String value();
041}