com.puppycrawl.tools.checkstyle.checks
Class TranslationCheck

java.lang.Object
  extended by com.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended by com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended by com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
              extended by com.puppycrawl.tools.checkstyle.checks.TranslationCheck
All Implemented Interfaces:
Configurable, Contextualizable, FileSetCheck

public class TranslationCheck
extends AbstractFileSetCheck

The TranslationCheck class helps to ensure the correct translation of code by checking property files for consistency regarding their keys. Two property files describing one and the same context are consistent if they contain the same keys.

An example of how to configure the check is:

 <module name="Translation"/>
 

Author:
Alexandra Bunge, lkuehne

Constructor Summary
TranslationCheck()
          Creates a new TranslationCheck instance.
 
Method Summary
 void beginProcessing(String aCharset)
          Called when about to be called to process a set of files.
 void finishProcessing()
          Called when all the files have been processed.
protected  void processFiltered(File aFile, List<String> aLines)
          Called to process a file that matches the specified file extensions.
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck
destroy, 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

TranslationCheck

public TranslationCheck()
Creates a new TranslationCheck instance.

Method Detail

beginProcessing

public void beginProcessing(String aCharset)
Description copied from class: AbstractFileSetCheck
Called when about to be called to process a set of files.

Specified by:
beginProcessing in interface FileSetCheck
Overrides:
beginProcessing in class AbstractFileSetCheck
Parameters:
aCharset - the character set used to read the files.

processFiltered

protected void processFiltered(File aFile,
                               List<String> aLines)
Description copied from class: AbstractFileSetCheck
Called to process a file that matches the specified file extensions.

Specified by:
processFiltered in class AbstractFileSetCheck
Parameters:
aFile - the file to be processed
aLines - an immutable list of the contents of the file.

finishProcessing

public void finishProcessing()
Description copied from class: AbstractFileSetCheck
Called when all the files have been processed. This is the time to perform any checks that need to be done across a set of files. In this method, the implementation is responsible for the logging of messages.

Specified by:
finishProcessing in interface FileSetCheck
Overrides:
finishProcessing in class AbstractFileSetCheck


Copyright © 2001-2014. All Rights Reserved.