ro.isdc.wro.model.resource.processor.impl
Class PlaceholderProcessor

java.lang.Object
  ro.isdc.wro.model.resource.processor.impl.PlaceholderProcessor

All Implemented Interfaces:

ResourcePostProcessor, ResourcePreProcessor

public class PlaceholderProcessor
extends Object
implements ResourcePreProcessor, ResourcePostProcessor

A processor which parse a resource and search for placeholders of this type: ${} and replace them with the values found in a map provided the by client.

Since:

1.3.8

Author:

Alex Objelean

Constructor Summary

PlaceholderProcessor()

Method Summary

void	process(Reader reader, Writer writer) Perform actual resource processing.
void	process(Resource resource, Reader reader, Writer writer) Process a content supplied by a reader and perform some sort of processing.
PlaceholderProcessor	setIgnoreMissingVariables(boolean ignoreMissingVariables)
PlaceholderProcessor	setPropertiesFactory(ObjectFactory<Properties> propertiesFactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceholderProcessor

public PlaceholderProcessor()

Method Detail

process

public void process(Reader reader,
                    Writer writer)
             throws IOException

Perform actual resource processing. The content to be processed is read from source Reader and is written to destination Writer. It is the client responsibility to close both: Reader and writer.

Specified by:

process in interface ResourcePostProcessor

Parameters:

reader - source stream.

writer - destination stream.

Throws:

IOException

process

public void process(Resource resource,
                    Reader reader,
                    Writer writer)
             throws IOException

Process a content supplied by a reader and perform some sort of processing. It is important to know that you should use reader for processing instead of trying to access the resource original content using Resource, because this way you can ignore the other preProcessors from the chain.
It is not require to explicitly handle exception. When the processing fails, the following can happen:

• the exception is wrapped in RuntimeException and the processing chain is interrupted (by default)
• content remains unchanged (if WroConfiguration.isIgnoreFailingProcessor() is true)

It is not required to close the reader and writers, because these will be closed for you.

Specified by:

process in interface ResourcePreProcessor

Parameters:

resource - the original resource as it found in the model.

reader - Reader used to read processed resource content.

writer - Writer where used to write processed results.

Throws:

IOException - when an exception occurs. The future version will change the exception type to Exception, because any exception may occur during processing. The processing failure will be handled based on value of WroConfiguration.isIgnoreFailingProcessor() configuration flag.

setIgnoreMissingVariables

public PlaceholderProcessor setIgnoreMissingVariables(boolean ignoreMissingVariables)

Parameters:

ignoreMissingVariables - the ignoreMissingVariables to set

setPropertiesFactory

public PlaceholderProcessor setPropertiesFactory(ObjectFactory<Properties> propertiesFactory)

Parameters:

propertiesFactory - the propertiesFactory to set