javax.persistence.Lob Maven / Gradle / Ivy

Go to download
package javax.persistence;

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

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

/**
 * Specifies that a persistent property or field should be persisted as a large object to a database-supported large object type.
 * 
 * 
 * Portable applications should use the Lob annotation when mapping to a database Lob type. The Lob annotation may
 * be used in conjunction with the {@link Basic} annotation or the {@link ElementCollection} annotation when the element collection value is
 * of basic type. A Lob may be either a binary or character type.
 * 
 * 

 * The Lob type is inferred from the type of the persistent field or property, and except for string and character-based types
 * defaults to Blob.
 * 
 * 
 * 
 *   Example 1:
 * 
 *   @Lob @Basic(fetch=LAZY)
 *   @Column(name="REPORT")
 *   protected String report;
 * 
 *   Example 2:
 * 
 *   @Lob @Basic(fetch=LAZY)
 *   @Column(name="EMP_PIC", columnDefinition="BLOB NOT NULL")
 *   protected byte[] pic;
 * 
 * 
 * 
 * @see Basic
 * @see ElementCollection
 * 
 * @since Java Persistence 1.0
 */
@Target({ METHOD, FIELD })
@Retention(RUNTIME)
public @interface Lob {}