ro.isdc.wro.extensions.processor.css
Class CssLintProcessor

java.lang.Object
  ro.isdc.wro.extensions.processor.css.CssLintProcessor

All Implemented Interfaces:

ResourcePostProcessor, ResourcePreProcessor

@SupportedResourceType(value=CSS)
public class CssLintProcessor
extends Object
implements ResourcePreProcessor, ResourcePostProcessor

Processor which analyze the css code and warns you found problems. The processing result won't change no matter if the processed script contains errors or not. The underlying implementation uses CSSLint script utility ://github.com/stubbornella/csslint.

Since:

1.3.8

Author:

Alex Objelean

Field Summary

static String

ALIAS

Constructor Summary

CssLintProcessor()

Method Summary

protected String	createDefaultOptions()
protected CssLint	newCssLint()
protected void	onCssLintException(CssLintException e, Resource resource) Called when CssLintException is thrown.
protected void	onException(WroRuntimeException e) Invoked when an unexpected exception occurred during processing.
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.
CssLintProcessor	setOptions(String... options) Deprecated.
CssLintProcessor	setOptionsAsString(String options)

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS

public static final String ALIAS

See Also:

Constant Field Values

Constructor Detail

CssLintProcessor

public CssLintProcessor()

Method Detail

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.

onException

protected void onException(WroRuntimeException e)

Invoked when an unexpected exception occurred during processing. By default the exception is thrown further.

newCssLint

protected CssLint newCssLint()

Returns:

CssLint instance.

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

onCssLintException

protected void onCssLintException(CssLintException e,
                                  Resource resource)

Called when CssLintException is thrown. Allows subclasses to re-throw this exception as a RuntimeException or handle it differently.

Parameters:

e - CssLintException which has occurred.

resource - the processed resource which caused the exception.

setOptionsAsString

public CssLintProcessor setOptionsAsString(String options)

Parameters:

options - a CSV representation of options.

setOptions

@Deprecated
public CssLintProcessor setOptions(String... options)

Deprecated.

Sets an array of options. Use setOptionsAsString(String) instead.

createDefaultOptions

protected String createDefaultOptions()

Returns:

default options to use for linting.