org.eclipse.ocl.examples.emf.validation.validity.export
Interface IValidityExporter

All Superinterfaces:

IValidityExporterDescriptor

All Known Implementing Classes:

AbstractExporter, HTMLExporter, ModelExporter, TextExporter

public interface IValidityExporter
extends IValidityExporterDescriptor

This interface defines the general contract of the validity results export mechanism.

Clients may also extends AbstractExport instead.

Method Summary

void	export(java.lang.Appendable s, org.eclipse.emf.ecore.resource.Resource validatedResource, RootNode rootNode, java.lang.String exportedFileName) Export the validity results to an Appendable.
java.lang.String	export(org.eclipse.emf.ecore.resource.Resource validatedResource, RootNode rootNode, java.lang.String fileName) Export the validity results and return String containing the results.
java.lang.String	getPreferredExtension()

Methods inherited from interface org.eclipse.ocl.examples.emf.validation.validity.export.IValidityExporterDescriptor

getExporter, getExporterType

Method Detail

export

@NonNull
java.lang.String export(@NonNull
                                org.eclipse.emf.ecore.resource.Resource validatedResource,
                                @NonNull
                                RootNode rootNode,
                                @Nullable
                                java.lang.String fileName)

Export the validity results and return String containing the results.

Parameters:

validatedResource - The resource to validate

rootNode - The Root Node to export

exportedFileName - The target file name or null if not known and not to be reported

Throws:

java.io.IOException

export

void export(@NonNull
            java.lang.Appendable s,
            @NonNull
            org.eclipse.emf.ecore.resource.Resource validatedResource,
            @NonNull
            RootNode rootNode,
            @Nullable
            java.lang.String exportedFileName)
            throws java.io.IOException

Export the validity results to an Appendable.

Parameters:

s - The appendable

validatedResource - The resource to validate

rootNode - The Root Node to export

exportedFileName - The target file name or null if not known and not to be reported

Throws:

java.io.IOException

getPreferredExtension

@Nullable
java.lang.String getPreferredExtension()