| /******************************************************************************* |
| * Copyright (c) 2010 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.utility.internal.iterables.ListIterable; |
| import org.eclipse.jpt.jaxb.core.xsd.XsdTypeDefinition; |
| |
| /** |
| * Represents a JAXB persistent type (class or enum). |
| * (A class with either an explicit or implicit @XmlType annotation) |
| * <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.0 |
| * @since 3.0 |
| */ |
| public interface JaxbPersistentType |
| extends JaxbType { |
| |
| /**************** factory class *****************/ |
| |
| /** |
| * factory class corresponds to the XmlType annotation factoryClass element |
| */ |
| String getFactoryClass(); |
| void setFactoryClass(String factoryClass); |
| String FACTORY_CLASS_PROPERTY = "factoryClass"; //$NON-NLS-1$ |
| |
| |
| /**************** factory method *****************/ |
| |
| /** |
| * factory method corresponds to the XmlType annotation factoryMethod element |
| */ |
| String getFactoryMethod(); |
| void setFactoryMethod(String factoryMethod); |
| String FACTORY_METHOD_PROPERTY = "factoryMethod"; //$NON-NLS-1$ |
| |
| |
| /**************** name *****************/ |
| |
| /** |
| * Return the specified xml type name or the default type name if it is not specified |
| */ |
| String getXmlTypeName(); |
| |
| /** |
| * Return the specified xml type name or null if it is not specified |
| */ |
| String getSpecifiedXmlTypeName(); |
| |
| /** |
| * Set the xml type name, null to unspecify (use the default) |
| */ |
| void setSpecifiedXmlTypeName(String xmlTypeName); |
| |
| /** |
| * String constant associated with changes to the specified xml type name |
| */ |
| String SPECIFIED_XML_TYPE_NAME_PROPERTY = "specifiedXmlTypeName"; //$NON-NLS-1$ |
| |
| /** |
| * Return the default xml type name |
| */ |
| String getDefaultXmlTypeName(); |
| |
| |
| /**************** namespace *****************/ |
| |
| /** |
| * Return the specified xml type namespace or the default namespace if it is not specified |
| */ |
| String getNamespace(); |
| |
| /** |
| * Return the specified xml type namespace or null if it is not specified |
| */ |
| String getSpecifiedNamespace(); |
| |
| /** |
| * Set the xml type namespace, null to unspecify (use the default) |
| */ |
| void setSpecifiedNamespace(String namespace); |
| |
| /** |
| * String constant associated with changes to the specified xml type namespace |
| */ |
| String SPECIFIED_NAMESPACE_PROPERTY = "specifiedNamespace"; //$NON-NLS-1$ |
| |
| /** |
| * Return the default namespace |
| */ |
| String getDefaultNamespace(); |
| |
| |
| /********** propOrder **********/ |
| |
| /** |
| * propOrder corresponds to the XmlType annotation propOrder element |
| */ |
| ListIterable<String> getPropOrder(); |
| int getPropOrderSize(); |
| void addProp(int index, String prop); |
| void removeProp(int index); |
| void removeProp(String prop); |
| void moveProp(int targetIndex, int sourceIndex); |
| String PROP_ORDER_LIST = "propOrder"; //$NON-NLS-1$ |
| |
| // ********** root element ************ |
| /** |
| * Return whether this class is a root element (has the XmlRootElement annotation) |
| */ |
| boolean isRootElement(); |
| |
| /** |
| * Return the root element or null if it is not a root element. |
| */ |
| XmlRootElement getRootElement(); |
| |
| /** |
| * Set the root element name, this will add the XmlRootElement annotation |
| * and set its name to the specified name. |
| * To remove the XmlRootElement annotation, pass in null. |
| * To set the name when the class is already a root element, |
| * set it directly on the XmlRootElement. |
| */ |
| XmlRootElement setRootElement(String name); |
| String ROOT_ELEMENT = "rootElement"; //$NON-NLS-1$ |
| |
| |
| // **************** misc ************************************************** |
| |
| XsdTypeDefinition getXsdTypeDefinition(); |
| |
| } |