org.apache.cocoon.generation
Interface GeneratorFactory

All Known Implementing Classes:

FileGeneratorFactory

public interface GeneratorFactory

A generator factory is the factory of Generators.

Regular GeneratorFactory implementation should be ThreadSafe component serving as a factory of lightweight Generator objects.

GeneratorFactory can implement any number of Avalon lifecycle interfaces and perform any initializations necessary. Ligtweight Generator instances created by getInstance() method will only need to parse additional parameters passed on sitemap component invocation via SitemapModelComponent.setup(org.apache.cocoon.environment.SourceResolver, java.util.Map, String, org.apache.avalon.framework.parameters.Parameters) method and can access global configuration of GeneratorFactory.

NOTE: Only Disposable interface is applicable to the Generator instance returned by the getInstance().

Since:

2.2

Version:

CVS $Id: GeneratorFactory.java 55383 2004-10-23 15:10:46Z cziegeler $

Author:

Vadim Gritsenko

Nested Class Summary

static interface

GeneratorFactory.Instance Instance of the Generator created by the GeneratorFactory

Field Summary

static String

ROLE

Method Summary

GeneratorFactory.Instance

getInstance() Create an instance of the Generator

Field Detail

ROLE

public static final String ROLE

Method Detail

getInstance

public GeneratorFactory.Instance getInstance()

Create an instance of the Generator