foundation/org.eclipse.persistence.core/src/main/java/org/eclipse/persistence/core/mappings/CoreAttributeAccessor.java

/*
 * Copyright (c) 2012, 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:
//     Blaise Doughan - 2.5 - initial implementation
package org.eclipse.persistence.core.mappings;

import org.eclipse.persistence.exceptions.DescriptorException;

/**
 * INTERNAL
 * A abstraction of attribute accessor capturing behavior common to all
 * persistence types.
 */
public interface CoreAttributeAccessor {

    /**
     * Return the class type of the attribute.
     */
    Class getAttributeClass();

    /**
     * INTERNAL:
     * Return the attribute name.
     */
    String getAttributeName();

    /**
     * Return the attribute value from the object.
     */
    Object getAttributeValueFromObject(Object object);

    /**
     * Allow any initialization to be performed with the descriptor class.
     */
    void initializeAttributes(Class descriptorClass) throws DescriptorException;

    boolean isInstanceVariableAttributeAccessor();

    boolean isMethodAttributeAccessor();

    /**
     * INTERNAL:
     */
    boolean isWriteOnly();

    /**
     * Set the attribute value into the object.
     */
    void setAttributeValueInObject(Object object, Object value);

    /**
     * INTERNAL
     */
    void setIsReadOnly(boolean aBoolean);

    void setIsWriteOnly(boolean aBoolean);

}