org.eclipse.persistence.oxm.annotations.XmlNamedSubgraph Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation

EclipseLink build based upon Git transaction f2b9fc5

There is a newer version: 5.0.0-B03

/*
 * Copyright (c) 2011, 2024 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:
//     Matt MacIvor - 2.5 - initial implementation
package org.eclipse.persistence.oxm.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * A XmlNamedSubgraph is a member element of a {@linkplain XmlNamedObjectGraph}.
 * The XmlNamedSubgraph is only referenced from within an {@linkplain XmlNamedObjectGraph}
 * and can not be referenced independently. It is referenced by its "name"
 * from an {@linkplain XmlNamedAttributeNode} element of the {@linkplain XmlNamedObjectGraph}.
 *
 * @see XmlNamedObjectGraph
 * @see XmlNamedAttributeNode
 *
 * @since EclipseLink 2.5
 */
@Target({TYPE})
@Retention(RUNTIME)
public @interface XmlNamedSubgraph {
   /**
    * The name of the subgraph
    */
   String name();

   /**
    * Only required for inheritance or with {@linkplain org.eclipse.persistence.oxm.mappings.XMLChoiceCollectionMapping}
    * or {@linkplain org.eclipse.persistence.oxm.mappings.XMLChoiceObjectMapping}
    * to specify which of the possible targets this subgraph is to be applied to.
    */
   Class type() default Object.class;

   /**
    * The list of properties to include in this graph.
    */
   XmlNamedAttributeNode[]  attributeNodes();
}