com.qulice.checkstyle

Class PuzzleFormatCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

com.qulice.checkstyle.PuzzleFormatCheck

All Implemented Interfaces:

Configurable, Contextualizable, FileSetCheck

public final class PuzzleFormatCheck
extends AbstractFileSetCheck

Check format of PDD puzzles.

This is how you should format them:

 /**
  * This is my new method.
  * @todo #123:1hr! I will implement it later, when more information
  *  come to light and I have some extra documentation
  */
 public void func() {
     // ...
 }
 

Full syntax is explained here.

Version:

$Id$

Author:

Krzysztof Krason (Krzysztof.Krason@gmail.com), Yegor Bugayenko (yegor@tpc2.com)

See Also:

Puzzle Driven Development

Suppressed Checkstyle violations:

PuzzleFormat (200 lines)

Constructor Summary

Constructors

Constructor and Description
PuzzleFormatCheck()

Method Summary

Methods

Modifier and Type	Method and Description
void	processFiltered(File file, List<String> lines)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck

beginProcessing, destroy, finishProcessing, fireErrors, getMessageCollector, getMessageDispatcher, init, log, log, process, setFileExtensions, setMessageDispatcher

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Configurable

configure

Methods inherited from interface com.puppycrawl.tools.checkstyle.api.Contextualizable

contextualize

Constructor Detail

PuzzleFormatCheck

public PuzzleFormatCheck()

Method Detail

processFiltered

public void processFiltered(File file,
                   List<String> lines)

Specified by:

processFiltered in class AbstractFileSetCheck