manifold.ext

Class AbstractExtensionProducer<M extends IModel>

java.lang.Object

manifold.api.service.BaseService

manifold.api.type.ResourceFileTypeManifold<M>

manifold.api.type.JavaTypeManifold<M>

manifold.ext.AbstractExtensionProducer<M>

All Implemented Interfaces:

IPluginHost, IService, IFileConnected, ISelfCompiled, ITypeManifold, IExtensionClassProducer

public abstract class AbstractExtensionProducer<M extends IModel>
extends JavaTypeManifold<M>
implements IExtensionClassProducer

An abstraction for a type manifold that produces Extension Classes to be processed by the ExtensionManifold. See ExtensionProducerSampleTypeManifold as a reference implementation.

Nested Class Summary

Nested classes/interfaces inherited from class manifold.api.type.ResourceFileTypeManifold

ResourceFileTypeManifold.CacheClearer

Field Summary

Fields inherited from interface manifold.api.type.ITypeManifold

ARG_DUMP_SOURCE

Constructor Summary

Constructors

Constructor and Description
AbstractExtensionProducer()

Method Summary

Modifier and Type	Method and Description
protected ResourceFileTypeManifold.CacheClearer	createCacheClearer()
protected abstract M	createModel(java.lang.String extensionClassName, java.util.Set<IFile> files)
protected abstract java.lang.String	deriveExtendedClassFrom(java.lang.String extensionClassFqn)
java.lang.String	findTopLevelFqn(java.lang.String fqn) Overridden because the file's fqn isn't really a type for this type manifold, only the extension classes derived from the files are types this manifold produces.
java.util.Set<java.lang.String>	getExtendedTypes() The set of extension classes this type manifold produces.
protected abstract java.util.Set<java.lang.String>	getExtendedTypes(IFile file)
java.util.Set<java.lang.String>	getExtendedTypesForFile(IFile file) The set of classes extended via {$code file}.
java.util.Set<java.lang.String>	getExtensionClasses(java.lang.String extendedType) The subset of extension classes this type manifold produces that extend fqn
protected abstract java.lang.String	getFileExt()
protected java.util.Map<java.lang.String,manifold.util.concurrent.LocklessLazyVar<M>>	getPeripheralTypes()
java.lang.String	getTypeNameForFile(java.lang.String defaultFqn, IFile file) The type name[s] produced from a file from an extension producer are the names of the extension classes
java.lang.String[]	getTypesForFile(IFile file)
boolean	handlesFileExtension(java.lang.String fileExtension)
void	init(IModule moduleComponent)
boolean	isExtendedType(java.lang.String fqn) Does this type manifold produce extension class[es] for fqn?
boolean	isInnerType(java.lang.String topLevelFqn, java.lang.String relativeInner)
protected abstract java.lang.String	makeExtensionClassName(java.lang.String extendedClassFqn)
RefreshKind	refreshedFile(IFile file, java.lang.String[] types, RefreshKind kind)

Methods inherited from class manifold.api.type.JavaTypeManifold

getClassType, getContributorKind, getSourceKind

Methods inherited from class manifold.api.type.ResourceFileTypeManifold

clear, contribute, contribute, findFilesForType, getAdditionalTypes, getAllTypeNames, getContent, getModel, getModule, getPackage, getTypeNames, handlesFile, init, isDuplicate, isPackage, isTopLevelType, isType

Methods inherited from class manifold.api.service.BaseService

doInit, doUninit, init, isInited, uninit

Methods inherited from class java.lang.Object

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

Methods inherited from interface manifold.api.type.ITypeManifold

accept, clear, contribute, enterPostJavaCompilation, findFilesForType, getAllTypeNames, getClassType, getContributorKind, getModule, getPackage, getSourceKind, getTypeNames, isPackage, isTopLevelType, isType

Methods inherited from interface manifold.api.type.IFileConnected

handlesFile

Methods inherited from interface manifold.api.type.ISelfCompiled

compile, isSelfCompile, parse

Methods inherited from interface manifold.api.service.IPluginHost

getInterface

Constructor Detail

AbstractExtensionProducer

public AbstractExtensionProducer()

Method Detail

init

public void init(IModule moduleComponent)

Specified by:

init in interface ITypeManifold

Overrides:

init in class ResourceFileTypeManifold<M extends IModel>

getFileExt

protected abstract java.lang.String getFileExt()

Returns:

The file extension of the resource files this type manifold processes

createModel

protected abstract M createModel(java.lang.String extensionClassName,
                                 java.util.Set<IFile> files)

Returns:

A new model for the qualified extensionClassName using files

makeExtensionClassName

protected abstract java.lang.String makeExtensionClassName(java.lang.String extendedClassFqn)

Returns:

The qualified extension class name corresponding with extendedClassFqn

deriveExtendedClassFrom

protected abstract java.lang.String deriveExtendedClassFrom(java.lang.String extensionClassFqn)

Returns:

The qualified extended class name derived from extendedClassFqn

getTypeNameForFile

public java.lang.String getTypeNameForFile(java.lang.String defaultFqn,
                                           IFile file)

The type name[s] produced from a file from an extension producer are the names of the extension classes

Overrides:

getTypeNameForFile in class ResourceFileTypeManifold<M extends IModel>

findTopLevelFqn

public java.lang.String findTopLevelFqn(java.lang.String fqn)

Overridden because the file's fqn isn't really a type for this type manifold, only the extension classes derived from the files are types this manifold produces.

Overrides:

findTopLevelFqn in class ResourceFileTypeManifold<M extends IModel>

createCacheClearer

protected ResourceFileTypeManifold.CacheClearer createCacheClearer()

Overrides:

createCacheClearer in class ResourceFileTypeManifold<M extends IModel>

refreshedFile

public RefreshKind refreshedFile(IFile file,
                                 java.lang.String[] types,
                                 RefreshKind kind)

Specified by:

refreshedFile in interface IFileConnected

Overrides:

refreshedFile in class ResourceFileTypeManifold<M extends IModel>

handlesFileExtension

public boolean handlesFileExtension(java.lang.String fileExtension)

Specified by:

handlesFileExtension in interface IFileConnected

getPeripheralTypes

protected java.util.Map<java.lang.String,manifold.util.concurrent.LocklessLazyVar<M>> getPeripheralTypes()

Overrides:

getPeripheralTypes in class ResourceFileTypeManifold<M extends IModel>

isInnerType

public boolean isInnerType(java.lang.String topLevelFqn,
                           java.lang.String relativeInner)

Specified by:

isInnerType in class ResourceFileTypeManifold<M extends IModel>

isExtendedType

public boolean isExtendedType(java.lang.String fqn)

Description copied from interface: IExtensionClassProducer

Does this type manifold produce extension class[es] for fqn?

Specified by:

isExtendedType in interface IExtensionClassProducer

Parameters:

fqn - The fully qualified name of a type for which this manifold may produce an extension class

Returns:

True if this manifold produces extension class[es] for fqn

getExtensionClasses

public java.util.Set<java.lang.String> getExtensionClasses(java.lang.String extendedType)

Description copied from interface: IExtensionClassProducer

The subset of extension classes this type manifold produces that extend fqn

Specified by:

getExtensionClasses in interface IExtensionClassProducer

Parameters:

extendedType - The fully qualified name of a potentially extended type

Returns:

The subset of extension classes this type manifold produces that extend fqn

getExtendedTypes

public java.util.Set<java.lang.String> getExtendedTypes()

Description copied from interface: IExtensionClassProducer

The set of extension classes this type manifold produces.

Specified by:

getExtendedTypes in interface IExtensionClassProducer

getTypesForFile

public java.lang.String[] getTypesForFile(IFile file)

Specified by:

getTypesForFile in interface IFileConnected

Overrides:

getTypesForFile in class ResourceFileTypeManifold<M extends IModel>

getExtendedTypesForFile

public java.util.Set<java.lang.String> getExtendedTypesForFile(IFile file)

Description copied from interface: IExtensionClassProducer

The set of classes extended via {$code file}.

Specified by:

getExtendedTypesForFile in interface IExtensionClassProducer

Parameters:

file - A resource file associated with this class producer

getExtendedTypes

protected abstract java.util.Set<java.lang.String> getExtendedTypes(IFile file)