ch.sahits.codegen.java.extensions
Class ReferenceImplementation

java.lang.Object
  ch.sahits.codegen.java.extensions.ReferenceImplementation

public final class ReferenceImplementation
extends java.lang.Object

This is a Helper class for the extension point ch.sahits.codegen.java.refimplementation

Since:

2.1.0

Author:

Andi Hotz, Sahits GmbH

Constructor Summary

ReferenceImplementation()

Method Summary

static IReferenceImplementation	getGenerator(java.lang.String name) Deprecated. User getRefImpl(String, String)
static java.lang.String	getHelpContextID(java.lang.String className) Deprecated. user getRefImpl(String, String) instead
static IReferenceImplementation	getRefImpl(java.lang.String bundle, java.lang.String className) Retrieve a reference implementation generator instance from the extension registry
static java.util.Map<java.lang.String,java.lang.String>	getRefImpl4DisplaySelection() This methods retrieves the map of reference implementation in the form .
static java.util.List<java.lang.String>	getRefImpl4Selection() This methods retrieves the list of reference implementations in the form bundle@refImpl.
static IGeneratorExtension	getRefImplExtension(java.lang.String bundle, java.lang.String name) Retrieve the reference implementation extension instance for the implementation
static IClassGeneratorExtension	getRefImplExtensionByClass(java.lang.String refImplClass) Deprecated. use getRefImpl(String, String)
static IClassGeneratorExtension	getRefImplExtensionByDisplay(java.lang.String display) Retrieve the generation extension
static IGeneratorCollection	getRefImpls() Retrieve all registered reference implementations
static java.net.URI	getRefImplSrc(java.lang.String name) Retrieve the IReferenceImplementation from the extension point.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceImplementation

public ReferenceImplementation()

Method Detail

getRefImpls

public static IGeneratorCollection getRefImpls()

Retrieve all registered reference implementations

Returns:

Collection of reference implementations

getRefImpl

public static IReferenceImplementation getRefImpl(java.lang.String bundle,
                                                  java.lang.String className)

Retrieve a reference implementation generator instance from the extension registry

Parameters:

bundle - name of the bundel the generator is defined in

className - fully qualified class name of the reference implementation

Returns:

Instance of the generator or null

getRefImplExtension

public static IGeneratorExtension getRefImplExtension(java.lang.String bundle,
                                                      java.lang.String name)

Retrieve the reference implementation extension instance for the implementation

Parameters:

bundle - nam of the bundle the reference implementation is located in

name - of the reference implementation

Returns:

instance of the reference implementation representation or null

getRefImpl4Selection

public static java.util.List<java.lang.String> getRefImpl4Selection()

This methods retrieves the list of reference implementations in the form bundle@refImpl. This method is not intended for external use.

Returns:

List of generators

getRefImpl4DisplaySelection

public static java.util.Map<java.lang.String,java.lang.String> getRefImpl4DisplaySelection()

This methods retrieves the map of reference implementation in the form . Each display name is unique. Should two generators have the same display name the second and all further will display the key as display name of the generator

Returns:

Map of generators

getGenerator

@Deprecated
public static IReferenceImplementation getGenerator(java.lang.String name)

Deprecated. User getRefImpl(String, String)

Retrieve the IReferenceImplementation from the extension point. If there are more than one implementation for one and the same class registered, the first found in the registry is choosen.

Parameters:

name - of the class (full name)

Returns:

Instance of an generator or null if for the specified product no implementation is found.

getHelpContextID

@Deprecated
public static java.lang.String getHelpContextID(java.lang.String className)

Deprecated. user getRefImpl(String, String) instead

Retreive the context help id for the reference implementation

Parameters:

className - fully qualified class name of the reference implementation

Returns:

Help contet ID

getRefImplSrc

public static java.net.URI getRefImplSrc(java.lang.String name)

Retrieve the IReferenceImplementation from the extension point. If there are more than one implementation for one and the same class registered, the first found in the registry is choosen.

Parameters:

name - of the class (full name)

Returns:

Instance of an generator or null if for the specified product no implementation is found.

getRefImplExtensionByDisplay

public static IClassGeneratorExtension getRefImplExtensionByDisplay(java.lang.String display)

Retrieve the generation extension

Parameters:

display - string

Returns:

Extension or null if no matching display string was found

getRefImplExtensionByClass

@Deprecated
public static IClassGeneratorExtension getRefImplExtensionByClass(java.lang.String refImplClass)

Deprecated. use getRefImpl(String, String)

Retrieve the generation extension

Parameters:

refImplClass - string

Returns:

Extension or null if no matching display string was found