oracle.jdeveloper.deploy.meta

Class PlatformRegistry

java.lang.Object

oracle.jdeveloper.deploy.meta.PlatformRegistry

public class PlatformRegistry
extends java.lang.Object

The Platform Registry singleton holds a list of all valid platforms recognized by JDeveloper. Accesssor methods may be used to query and retrieve closest matching platforms.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlatformRegistry.VersionMatch

Method Summary

Modifier and Type	Method and Description
static Platform	getDefaultPlatform()
static Platform	getPlatform(PlatformType type, PlatformVersion version) Get a platform matching the type and version supplied.
static Platform	getPlatform(PlatformType type, PlatformVersion version, PlatformRegistry.VersionMatch matchType) Returns the best matching Platform depending on matchType.
static Platform	getPlatform(PlatformType type, java.lang.String version) Constructs a PlatformVersion from a version string in its canonical form (e.g "10.1.3") and calls the preceding version of getPlatform()
static Platform[]	getPlatforms() Retrieve all platforms in the registry.
static Platform[]	getPlatforms(PlatformType filterOnType) Retrieve all registerd platforms of a type.
static Platform[]	getPlatforms(PlatformType filterOnType, boolean includeSubTypes) This version of getPlatforms() takes a boolean parameter which specifies whether subtypes (or extensions) of filterOnType should be included in the result.
static void	registerPlatform(Platform platform)
static void	setDefaultPlatform(Platform platform)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setDefaultPlatform

public static void setDefaultPlatform(Platform platform)
                               throws MetadataException

Throws:

MetadataException

getDefaultPlatform

public static Platform getDefaultPlatform()

registerPlatform

public static void registerPlatform(Platform platform)

getPlatform

public static Platform getPlatform(PlatformType type,
                                   PlatformVersion version)
                            throws MetadataException

Get a platform matching the type and version supplied. If an exact match is not found, a version that matches upto the UPDATE number (third number) will be returned.

Parameters:

type - one of the constants defined in PlatformType

version -

Returns:

a Platform object if a match is found.

Throws:

MetadataException - if the specified version cannot be found. Use the version of getPlatform() that takes a matchType if you do not wish an exception to be thrown.

getPlatform

public static Platform getPlatform(PlatformType type,
                                   java.lang.String version)
                            throws MetadataException

Constructs a PlatformVersion from a version string in its canonical form (e.g "10.1.3") and calls the preceding version of getPlatform()

Parameters:

version - the version as a canonical String.

Throws:

MetadataException

getPlatform

public static Platform getPlatform(PlatformType type,
                                   PlatformVersion version,
                                   PlatformRegistry.VersionMatch matchType)

Returns the best matching Platform depending on matchType.

Parameters:

type - the Platform type

version - the version requested. Can be null if matchType is MATCH_NONE

matchType - the accuracy of the desired match.

getPlatforms

public static Platform[] getPlatforms()

Retrieve all platforms in the registry.

getPlatforms

public static Platform[] getPlatforms(PlatformType filterOnType)

Retrieve all registerd platforms of a type.

Parameters:

filterOnType - The type of platform to filter on. This should be one of the constants in PlatformType.

Returns:

array of Platform objects.

getPlatforms

public static Platform[] getPlatforms(PlatformType filterOnType,
                                      boolean includeSubTypes)

This version of getPlatforms() takes a boolean parameter which specifies whether subtypes (or extensions) of filterOnType should be included in the result.

Parameters:

filterOnType -

includeSubTypes - if true, include PlatformTypes that are an extension of filterOnType, for example, getPlatforms(PlatformType.J2EE, true) would return all J2EE platforms including OC4J, WebLogic, etc.

Returns: