de.smartics.testdoc.core.doc.names
Class EnglishTestNameUtils

java.lang.Object
  de.smartics.testdoc.core.doc.names.EnglishTestNameUtils

All Implemented Interfaces:

TestNameUtils

public class EnglishTestNameUtils
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      TestNameUtils
     
     

Calculates valid names for test names written in English.

Author:

Robert Reiner

Constructor Summary

EnglishTestNameUtils()
Default constructor.

Method Summary

String

calculateTestNameSentence(String testName) The implementation dependent translation of the test name into a sentence.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnglishTestNameUtils

public EnglishTestNameUtils()

Default constructor.

Method Detail

calculateTestNameSentence

public String calculateTestNameSentence(String testName)
                                 throws IllegalArgumentException

The implementation dependent translation of the test name into a sentence.

Specified by:

calculateTestNameSentence in interface TestNameUtils

Parameters:

testName - the name of the test method.

Returns:

the test name translated into a sentence to be displayed in the documentation.

Throws:

IllegalArgumentException - if testName is blank.

See Also:

TestNameUtils.calculateTestNameSentence(java.lang.String)