blob: 24ab60ca6e0c828f08a476fbc977d6017525d646 (
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
|
/*******************************************************************************
* Copyright (c) 2010, 2012 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.platform;
import org.eclipse.jpt.common.utility.filter.Filter;
import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;
/**
* Metadata that describes a JPA platform as defined in an
* extension to the <code>org.eclipse.jpt.jpa.core.jpaPlatforms</code>
* extension point.
* <p>
* See <code>org.eclipse.jpt.jpa.core/plugin.xml:jpaPlatforms</code>.
* <p>
* Not intended to be implemented by clients.
* <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 JpaPlatformConfig {
/**
* Return the config's manager.
*/
JpaPlatformManager getJpaPlatformManager();
/**
* Return the config's extension-supplied ID.
* This is unique among all the JPA platform configs.
*/
String getId();
/**
* Return the config's extension-supplied label.
*/
String getLabel();
/**
* Return the config's extension-supplied factory class name.
* The class must be instantiable and implement the
* {@link org.eclipse.jpt.jpa.core.JpaPlatformFactory} interface.
*/
String getFactoryClassName();
/**
* Return whether the config's JPA platform supports the specified
* JPA facet version. If the extension specifies a JPA facet version, it
* must be the same as the specified JPA facet version. If the extension
* does <em>not</em> specify a JPA facet verion, the config's JPA
* platform supports all JPA facet versions.
* @exception IllegalArgumentException if the specified facet version is
* not for a JPA facet
*/
boolean supportsJpaFacetVersion(IProjectFacetVersion jpaFacetVersion);
/**
* Return whether the config's JPA platform can be used as the default
* JPA platform for its {@link #supportsJpaFacetVersion(IProjectFacetVersion)
* supported JPA facet versions}.
*/
boolean isDefault();
/**
* Return config's group config.
*/
JpaPlatformGroupConfig getGroupConfig();
/**
* Return the ID of the plug-in that contributed the JPA platform
* config.
*/
String getPluginId();
Filter<JpaPlatformConfig> DEFAULT_FILTER = new DefaultFilter();
/* CU private */ static class DefaultFilter
extends Filter.Adapter<JpaPlatformConfig>
{
@Override
public boolean accept(JpaPlatformConfig config) {
return config.isDefault();
}
}
}
|
