Module omix.api

Package omix.plugin.ovl

Interface OVLCompatibilityHandlerInterface

public interface OVLCompatibilityHandlerInterface

This interface allows to implement compatibility features of a plug-in with its former versions.

Since:

Omix 1.5.12

Author:

Dr. Peter Droste

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OVLCompatibilityHandlerInterface.OVLFieldConverterInterface	The substitution is performed by this interface.
static class	OVLCompatibilityHandlerInterface.Substitution	A Substitution consisting of the namespace of the new class/field/accessory and the new name of the member.

Method Summary

Modifier and Type	Method	Description
default OVLCompatibilityHandlerInterface.Substitution	convertOVLAccessory(String namespace, ClassType classType, String accessory)	Converts a deprecated OVL accessory into a substituted OVL accessory of the current plug-in version.
default OVLCompatibilityHandlerInterface.Substitution	convertOVLClass(String namespace, String classType)	Converts a deprecated OVL class type name into a substituted OVL class of the current plug-in version.
default OVLCompatibilityHandlerInterface.Substitution	convertOVLField(String namespace, ClassType classType, String field)	Converts a deprecated OVL field into a substituted OVL field of the current plug-in version.
default OVLCompatibilityHandlerInterface.OVLFieldConverterInterface	getOVLFieldConverter(String namespace, ClassType classType, String field)	Takes data of a deprecated OVL field and saves it in different manner.

Method Details

convertOVLClass

default OVLCompatibilityHandlerInterface.Substitution convertOVLClass(String namespace, String classType)

Converts a deprecated OVL class type name into a substituted OVL class of the current plug-in version. Omix iterates the list of installed OVLCompatibilityHandlers ordered by time of installation. If one handler converts the deprecated class name successfully into a OVLCompatibilityHandlerInterface.Substitution object all other existing OVLCompatibilityHandlers are skipped.

Parameters:

namespace - old namespace of the plug-in using the classType

classType - deprecated class name

Returns:

Substitution

convertOVLField

default OVLCompatibilityHandlerInterface.Substitution convertOVLField(String namespace, ClassType classType, String field)

Converts a deprecated OVL field into a substituted OVL field of the current plug-in version. Omix iterates the list of installed OVLCompatibilityHandlers ordered by time of installation. If one handler converts the deprecated field name successfully into a OVLCompatibilityHandlerInterface.Substitution object all other existing OVLCompatibilityHandlers are skipped.

Parameters:

namespace - old namespace of the plug-in using the classType

classType - class owning the field

field - deprecated field name

Returns:

Substitution

convertOVLAccessory

default OVLCompatibilityHandlerInterface.Substitution convertOVLAccessory(String namespace, ClassType classType, String accessory)

Converts a deprecated OVL accessory into a substituted OVL accessory of the current plug-in version. Omix iterates the list of installed OVLCompatibilityHandlers ordered by time of installation. If one handler converts the deprecated field name successfully into a OVLCompatibilityHandlerInterface.Substitution object all other existing OVLCompatibilityHandlers are skipped.

Parameters:

namespace - old namespace of the plug-in using the classType

classType - class owning the accessory

accessory - deprecated accessory name

Returns:

Substitution

getOVLFieldConverter

default OVLCompatibilityHandlerInterface.OVLFieldConverterInterface getOVLFieldConverter(String namespace, ClassType classType, String field)

Takes data of a deprecated OVL field and saves it in different manner. Omix iterates the list of installed OVLCompatibilityHandlers ordered by time of installation. If one handler converts the deprecated field name successfully into a OVLCompatibilityHandlerInterface.Substitution object all other existing OVLCompatibilityHandlers are skipped.

Parameters:

namespace - old namespace of the plug-in using the classType

classType - class owning the field

field - deprecated field name

Returns:

Substitution