blob: fb16f1d95fd7441855f0ac11eba24169eda6d324 (
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
|
/*******************************************************************************
* Copyright (c) 2009, 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.jpa.core.context.java;
import java.util.Iterator;
import java.util.List;
import org.eclipse.core.resources.IFolder;
import org.eclipse.jpt.jpa.core.JpaStructureNode;
import org.eclipse.jpt.jpa.core.context.JpaContextNode;
import org.eclipse.jpt.jpa.core.context.PersistentType;
import org.eclipse.jpt.jpa.core.context.persistence.PersistentTypeContainer;
import org.eclipse.jpt.jpa.core.resource.java.JavaResourcePackageFragmentRoot;
import org.eclipse.wst.validation.internal.provisional.core.IMessage;
import org.eclipse.wst.validation.internal.provisional.core.IReporter;
/**
* A JAR file identified by a <code>persistence.xml</code> <code>jar-file</code> element.
* This holds persistent types corresponding to all the "persistable" types
* discovered in the JAR.
* <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 2.3
* @since 2.2
*/
public interface JarFile
extends JpaContextNode, JpaStructureNode, PersistentTypeContainer
{
JavaResourcePackageFragmentRoot getJarResourcePackageFragmentRoot();
// ********** Java persistent types **********
/**
* Return the JAR file's Java persistent types.
* Return only the types that are annotated with JPA annotations.
*/
Iterator<JavaPersistentType> javaPersistentTypes();
String JAVA_PERSISTENT_TYPES_COLLECTION = "javaPersistentTypes"; //$NON-NLS-1$
/**
* Return the size of the JAR file's Java persistent types.
*/
int javaPersistentTypesSize();
/**
* Return the persistent type with the specified name.
* Return null if the persistent type is not found.
*/
PersistentType getPersistentType(String typeName);
// ********** validation **********
/**
* Add to the list of current validation messages
*/
void validate(List<IMessage> messages, IReporter reporter);
/**
* Return true if this jar file exists in the given folder
*/
boolean isIn(IFolder folder);
}
|
