org.eclipse.persistence.annotations.TransientCompatibleAnnotations 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) 1998, 2021 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:
//     tware - added in fix for bug 277550
package org.eclipse.persistence.annotations;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * PUBLIC:
 *
 * This class is used by our JPA annotation processing to discover which annotations may coexist with a
 * jakarta.persistence.Transient annotation.  If jakarta.persistence.Transient appears on a field or property with an
 * annotation in the jakarta.persistence or org.eclipse.persistence package that is not in the list returned by getTransientCompatibleAnnotations()
 * an exception will be thrown.
 * @author tware
 *
 */
public class TransientCompatibleAnnotations {

    private static final List transientCompatibleAnnotations = Collections.unmodifiableList(new ArrayList() {{
        add("jakarta.persistence.PersistenceUnits");
        add("jakarta.persistence.PersistenceUnit");
        add("jakarta.persistence.PersistenceContext");
        add("jakarta.persistence.PersistenceContexts");
        add("jakarta.persistence.Access");
        add("jakarta.persistence.Transient");
    }});

    /**
     * PUBLIC:
     * Return a list of classnames of annotations that are compatible with the jakarta.persistence.Transient
     * annotation.
     */
    public static List getTransientCompatibleAnnotations(){
        return transientCompatibleAnnotations;
    }

    private TransientCompatibleAnnotations() {
        // no instance please
    }
}