oracle.toplink.essentials.mappings.AttributeAccessor Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.mappings;
import java.io.*;
import oracle.toplink.essentials.exceptions.*;
import oracle.toplink.essentials.internal.helper.ClassConstants;
/**
* Purpose: This provides an abstract class for setting and retrieving
* the attribute value for the mapping from an object.
* It can be used in advanced situations if the attribute
* requires advanced conversion of the mapping value, or a real attribute does not exist.
*
* @author James
* @since OracleAS TopLink 10g (10.0.3)
*/
public abstract class AttributeAccessor implements Cloneable, Serializable {
/** Stores the name of the attribute */
protected String attributeName;
/**
* INTERNAL:
* Clones itself.
*/
public Object clone() {
try {
return super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError();
}
}
/**
* INTERNAL:
* Return the attribute name.
*/
public String getAttributeName() {
return attributeName;
}
/**
* INTERNAL:
* Set the attribute name.
*/
public void setAttributeName(String attributeName) {
this.attributeName = attributeName;
}
/**
* Return the class type of the attribute.
*/
public Class getAttributeClass() {
return ClassConstants.OBJECT;
}
/**
* Allow any initialization to be performed with the descriptor class.
*/
public void initializeAttributes(Class descriptorClass) throws DescriptorException {
if (getAttributeName() == null) {
throw DescriptorException.attributeNameNotSpecified();
}
}
/**
* Return the attribute value from the object.
*/
public abstract Object getAttributeValueFromObject(Object object) throws DescriptorException;
/**
* Set the attribute value into the object.
*/
public abstract void setAttributeValueInObject(Object object, Object value) throws DescriptorException;
}