All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.persistence.annotations.Array Maven / Gradle / Ivy

The newest version!
/*
 * 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:
//     Oracle - initial API and implementation
package org.eclipse.persistence.annotations;

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

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Array types are extended object-relational data-types supported by some databases.
 * Array types are user define types in the database such as VARRAY types on Oracle.
 * Arrays can contain basic types (VARCHAR) or other Struct types, and can be stored in
 * a column or in a Struct type.
 * 

* This annotation can be defined on a collection attribute that is * persisted to an Array type. The collection can be of basic types, or embeddable * class mapped using a Struct. * * @see org.eclipse.persistence.mappings.structures.ObjectRelationalDataTypeDescriptor * @see org.eclipse.persistence.mappings.structures.ArrayMapping * @see org.eclipse.persistence.mappings.structures.ObjectArrayMapping * @author James Sutherland * @since EclipseLink 2.3 */ @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface Array { /** * The basic or embeddable class that is the element type of the collection. *

* This element is optional only if the collection field or property * is defined using Java generics, and must be specified otherwise. *

* It defaults to the parameterized type of the collection * when defined using generics. */ Class targetClass() default void.class; /** * The database name of the database array structure type. */ String databaseType(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy