Skip to main content
summaryrefslogtreecommitdiffstats
blob: ae866f61b089eb0eb8902b8d406274951de0f2ca (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
97
98
99
100
101
102
103
104
105
106
107
108
109
/*******************************************************************************
 * Copyright (c) 2010, 2013 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.platform;

import org.eclipse.jpt.common.utility.predicate.Predicate;
import org.eclipse.wst.common.project.facet.core.IProjectFacetVersion;

/**
 * Metadata that describes a JAXB platform as defined in an
 * extension to the <code>org.eclipse.jpt.jaxb.core.jaxbPlatforms</code>
 * extension point.
 * <p>
 * See <code>org.eclipse.jpt.jaxb.core/plugin.xml:jaxbPlatforms</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 JaxbPlatformConfig {
	/**
	 * Return the config's manager.
	 */
	JaxbPlatformManager getJaxbPlatformManager();

	/**
	 * Return the config's extension-supplied ID.
	 * This is unique among all the JAXB 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.jaxb.core.platform.JaxbPlatformDefinitionFactory} interface.
	 */
	String getFactoryClassName();

	/**
	 * Return whether the config's JAXB platform supports the specified
	 * JAXB facet version. If the extension specifies a JAXB facet version, it
	 * must be the same as the specified JAXB facet version. If the extension
	 * does <em>not</em> specify a JAXB facet verion, the config's JAXB
	 * platform supports all JAXB facet versions.
	 * @exception IllegalArgumentException if the specified facet version is
	 * not for a JAXB facet
	 */
	boolean supportsJaxbFacetVersion(IProjectFacetVersion jaxbFacetVersion);

	class SupportsJaxbFacetVersion
		extends Predicate.Adapter<JaxbPlatformConfig>
	{
		private final IProjectFacetVersion jaxbFacetVersion;
		public SupportsJaxbFacetVersion(IProjectFacetVersion jaxbFacetVersion) {
			super();
			this.jaxbFacetVersion = jaxbFacetVersion;
		}
		@Override
		public boolean evaluate(JaxbPlatformConfig config) {
			return config.supportsJaxbFacetVersion(this.jaxbFacetVersion);
		}
	}

	/**
	 * Return whether the config's JAXB platform can be used as the default
	 * JAXB platform for its {@link #supportsJaxbFacetVersion(IProjectFacetVersion)
	 * supported JAXB facet versions}.
	 */
	boolean isDefault();

	Predicate<JaxbPlatformConfig> IS_DEFAULT = new IsDefault();
	class IsDefault
		extends Predicate.Adapter<JaxbPlatformConfig>
	{
		@Override
		public boolean evaluate(JaxbPlatformConfig config) {
			return config.isDefault();
		}
	}

	/**
	 * Return config's group config.
	 */
	JaxbPlatformGroupConfig getGroupConfig();

	/**
	 * Return the ID of the plug-in that contributed the JAXB platform
	 * config.
	 */
	String getPluginId();
}

Back to the top