jakarta.persistence.NamedSubgraph Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Linda DeMichiel - 2.1

package jakarta.persistence;

import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * A NamedSubgraph is a member element of a
 * NamedEntityGraph.  The NamedSubgraph is
 * only referenced from within a NamedEntityGraph and can not be
 * referenced independently.  It is referenced by its name
 * from a NamedAttributeNode element of the 
 * NamedEntityGraph.
 *
 * @see NamedEntityGraph
 * @see NamedAttributeNode
 *
 * @since 2.1
 */
@Target({})
@Retention(RUNTIME)
public @interface NamedSubgraph {

    /**
     * (Required) The name of the subgraph as referenced from a
     * NamedAttributeNode element.
     */
    String name();

    /**
     * (Optional) The type represented by this subgraph.  The element
     * must be specified when this subgraph is extending a definition
     * on behalf of a subclass.
     */
    Class type() default void.class;

    /** 
     * (Required) The list of the attributes of the class that must
     * be included.  If the named subgraph corresponds to a subclass
     * of the class referenced by the corresponding attribute node,
     * then only subclass-specific attributes are listed.
     */
    NamedAttributeNode[] attributeNodes();
}