blob: bc6effc3bf0b4fd29503ca3d5f6f069b5040fc85 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/*******************************************************************************
* 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 {
// ***** schema type ref *****
JaxbSchemaComponentRef getSchemaTypeRef();
// **************** 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$
// ********** 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();
}
|
