de.intarsys.tools.factory

Class CommonFactory<T>

java.lang.Object

de.intarsys.tools.factory.CommonFactory<T>

Type Parameters:

T -

All Implemented Interfaces:

IAttributeSupport, ICategorySupport, IContextSupport, IFileEnvironment, IFactory<T>, IElementConfigurable, ILocatorFactorySupport, IPresentationSupport, IClassLoaderSupport

Direct Known Subclasses:

CredentialFactory, GenericFactory

public abstract class CommonFactory<T>
extends Object
implements IFactory<T>, IPresentationSupport, IElementConfigurable, IContextSupport, IClassLoaderSupport, ILocatorFactorySupport, IFileEnvironment, ICategorySupport, IAttributeSupport

A common versatile base class for implementing IFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARG_CLASSLOADER
static String	ARG_CONFIGURATION
static String	ARG_CONTEXT

Fields inherited from interface de.intarsys.tools.presentation.IPresentationSupport

ATTR_DESCRIPTION, ATTR_ICON, ATTR_LABEL, ATTR_TIP

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(IElement pElement)
T	createInstance(IArgs args)
Object	getAttribute(Object key) Get an attribute value from the context
File	getBaseDir() The platform base directory.
ICategory	getCategory() The ICategory for this.
ClassLoader	getClassLoader() A ClassLoader instance suitable to load classes and resources in the context of the receiver.
Object	getContext()
String	getDescription() A long, descriptive string representation.
String	getIconName() A name for an icon.
String	getId()
IElement	getInstanceConfiguration()
String	getLabel() A short string representation (suitable for example for use with an icon or menu item).
ILocatorFactory	getLocatorFactory() An ILocatorFactory to lookup resources in the context of the receiver.
File	getProfileDir() Some user specific private directory.
File	getTempDir() The directory for temporary files.
String	getTip() An "intermediate" length description (suitable for example with a tooltip).
File	getWorkingDir() The working directory.
Object	removeAttribute(Object key) Remove an attribute binding in the context
Object	setAttribute(Object key, Object value) Set the value of an attribute in the context
void	setClassLoader(ClassLoader classLoader)
void	setContext(Object context)
void	setDescription(Object description)
void	setIconName(String iconName)
void	setInstanceConfiguration(IElement instanceConfiguration)
void	setLabel(Object label)
void	setTip(Object tip)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.intarsys.tools.factory.IFactory

getResultType

Field Detail

ARG_CONFIGURATION

public static final String ARG_CONFIGURATION

See Also:

Constant Field Values

ARG_CONTEXT

public static final String ARG_CONTEXT

See Also:

Constant Field Values

ARG_CLASSLOADER

public static final String ARG_CLASSLOADER

See Also:

Constant Field Values

Method Detail

configure

public void configure(IElement pElement)
               throws ConfigurationException

Specified by:

configure in interface IElementConfigurable

Throws:

ConfigurationException

createInstance

public final T createInstance(IArgs args)
                       throws ObjectCreationException

Specified by:

createInstance in interface IFactory<T>

Throws:

ObjectCreationException

getAttribute

public Object getAttribute(Object key)

Description copied from interface: IAttributeSupport

Get an attribute value from the context

Specified by:

getAttribute in interface IAttributeSupport

Parameters:

key - the name of the attribute to get

Returns:

The value of the attribute key

getBaseDir

public File getBaseDir()

Description copied from interface: IFileEnvironment

The platform base directory.

Normally this will be equal to the VM "user.dir" property.

Specified by:

getBaseDir in interface IFileEnvironment

Returns:

The platform base directory.

getCategory

public ICategory getCategory()

Description copied from interface: ICategorySupport

The ICategory for this.

Specified by:

getCategory in interface ICategorySupport

Returns:

The ICategory for this.

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: IClassLoaderSupport

A ClassLoader instance suitable to load classes and resources in the context of the receiver.

Specified by:

getClassLoader in interface IClassLoaderSupport

Returns:

A ClassLoader instance suitable to load classes and resources in the context of the receiver.

getContext

public Object getContext()

getDescription

public String getDescription()

Description copied from interface: IPresentationSupport

A long, descriptive string representation.

Specified by:

getDescription in interface IPresentationSupport

Returns:

A long, descriptive string representation.

getIconName

public String getIconName()

Description copied from interface: IPresentationSupport

A name for an icon.

Specified by:

getIconName in interface IPresentationSupport

Returns:

A name for an icon.

getId

public String getId()

Specified by:

getId in interface IFactory<T>

getInstanceConfiguration

public IElement getInstanceConfiguration()

getLabel

public String getLabel()

Description copied from interface: IPresentationSupport

A short string representation (suitable for example for use with an icon or menu item).

Specified by:

getLabel in interface IPresentationSupport

Returns:

A short string representation (suitable for example for use with an icon or menu item).

getLocatorFactory

public ILocatorFactory getLocatorFactory()

Description copied from interface: ILocatorFactorySupport

An ILocatorFactory to lookup resources in the context of the receiver.

Specified by:

getLocatorFactory in interface ILocatorFactorySupport

Returns:

An ILocatorFactory to lookup resources in the context of the receiver.

getProfileDir

public File getProfileDir()

Description copied from interface: IFileEnvironment

Some user specific private directory.

Normally this will be equal to the VM "user.home" property or an application defined subdirectory.

Specified by:

getProfileDir in interface IFileEnvironment

Returns:

Some private directory.

getTempDir

public File getTempDir()

Description copied from interface: IFileEnvironment

The directory for temporary files.

Normally this will be equal to the VM "java.io.tmpdir" property.

Specified by:

getTempDir in interface IFileEnvironment

Returns:

The directory for temporary files.

getTip

public String getTip()

Description copied from interface: IPresentationSupport

An "intermediate" length description (suitable for example with a tooltip).

Specified by:

getTip in interface IPresentationSupport

Returns:

An "intermediate" length description (suitable for example with a tooltip).

getWorkingDir

public File getWorkingDir()

Description copied from interface: IFileEnvironment

The working directory.

Normally this will be equal to the VM "user.dir" property.

Specified by:

getWorkingDir in interface IFileEnvironment

Returns:

The working directory.

removeAttribute

public Object removeAttribute(Object key)

Description copied from interface: IAttributeSupport

Remove an attribute binding in the context

Specified by:

removeAttribute in interface IAttributeSupport

Parameters:

key - the name of the attribute to remove

Returns:

The previously associated value for key

setAttribute

public Object setAttribute(Object key,
                  Object value)

Description copied from interface: IAttributeSupport

Set the value of an attribute in the context

Specified by:

setAttribute in interface IAttributeSupport

Parameters:

key - the name of the attribute to set

value - the new value the attribute

Returns:

The previously associated value for key

setClassLoader

public void setClassLoader(ClassLoader classLoader)

setContext

public void setContext(Object context)
                throws ConfigurationException

Specified by:

setContext in interface IContextSupport

Throws:

ConfigurationException

setDescription

public void setDescription(Object description)

setIconName

public void setIconName(String iconName)

setInstanceConfiguration

public void setInstanceConfiguration(IElement instanceConfiguration)

setLabel

public void setLabel(Object label)

setTip

public void setTip(Object tip)

toString

public String toString()

Overrides:

toString in class Object