| /******************************************************************************* |
| * Copyright (c) 2011 Oracle. All rights reserved. |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v1.0, which accompanies this distribution |
| * and is available at http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * Oracle - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.jpt.jaxb.core.context; |
| |
| import org.eclipse.jpt.common.core.resource.java.JavaResourceAttribute; |
| import org.eclipse.jpt.jaxb.core.context.java.JavaContextNode; |
| |
| |
| /** |
| * Represents a JAXB attribute mapping. |
| * <p> |
| * Provisional API: This interface is part of an interim API that is still |
| * under development and expected to change significantly before reaching |
| * stability. It is available at this early stage to solicit feedback from |
| * pioneering adopters on the understanding that any code that uses this API |
| * will almost certainly be broken (repeatedly) as the API evolves. |
| * |
| * @version 3.1 |
| * @since 3.0 |
| */ |
| public interface JaxbAttributeMapping |
| extends JavaContextNode { |
| |
| String getKey(); |
| |
| JavaResourceAttribute getJavaResourceAttribute(); |
| |
| JaxbPersistentAttribute getPersistentAttribute(); |
| |
| JaxbClassMapping getClassMapping(); |
| |
| |
| // ***** default ***** |
| |
| String DEFAULT_PROPERTY = "default"; //$NON-NLS-1$ |
| |
| /** |
| * Return whether the mapping is its attribute's <em>default</em> mapping |
| * (as opposed to its <em>specified</em> mapping). |
| */ |
| boolean isDefault(); |
| |
| |
| // ***** misc ***** |
| |
| /** |
| * Return the (fully qualified) type of the attribute |
| * (or the item type if in a collection/array) |
| */ |
| String getBoundTypeName(); |
| |
| /** |
| * Return the (fully qualified) type used to map the bound type. |
| * (Usually the same as the value type, except when an XmlJavaTypeAdapter is used.) |
| */ |
| String getValueTypeName(); |
| |
| /** |
| * Return the (fully qualified) type of the data actually written to xml. |
| * (Usually the same as the value type, except when an XmlIDREF is used.) |
| */ |
| String getDataTypeName(); |
| |
| /** |
| * Return all directly referenced types, fully qualified. |
| * (Used for constructing Jaxb context) |
| */ |
| Iterable<String> getReferencedXmlTypeNames(); |
| |
| /** |
| * Return whether the attribute is mapped to a particle |
| * (e.g. XmlElement, XmlElements, XmlElementRef, XmlElementRefs) |
| */ |
| boolean isParticleMapping(); |
| |
| /** |
| * Return whether the attribute is specifically excluded from being mapped |
| * (e.g. XmlTransient) |
| */ |
| boolean isTransient(); |
| } |