com.harukizaemon.simian

## Interface AuditListener

- All Known Implementing Classes:
    CompositeAuditListener, DecoratorAuditListener

      public interface AuditListener

  Classes wishing to be notified of checking events should implement this interface.
  Version:
    $Id: AuditListener.java 3019 2007-11-08 09:59:10Z haruki_zaemon $
  Author:
    Simon Harris

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `block(Block block)` Called once for each block of duplicate lines within a set.
    `void` | `endCheck(CheckSummary summary)` Called when checking has finished.
    `void` | `endSet(java.lang.String text)` Called to indicate the end of a set of blocks of duplicate lines.
    `void` | `fileProcessed(SourceFile sourceFile)` Called when a file has been loaded.
    `void` | `startCheck(Options options)` Called when checking begins.
    `void` | `startSet(int lineCount)` Called to indicate the start of a set of blocks of duplicate lines.

- - ### Method Detail

    - #### startCheck

          void startCheck(Options options)

      Called when checking begins.
      Parameters:
        `options` - The options used when performing the check

    - #### fileProcessed

          void fileProcessed(SourceFile sourceFile)

      Called when a file has been loaded.
      Parameters:
        `sourceFile` - The file that was just loaded

    - #### startSet

          void startSet(int lineCount)

      Called to indicate the start of a set of blocks of duplicate lines.
      Parameters:
        `lineCount` - The number of lines the blocks have in common

    - #### block

          void block(Block block)

      Called once for each block of duplicate lines within a set.
      Parameters:
        `block` - the duplicated block.

    - #### endSet

          void endSet(java.lang.String text)

      Called to indicate the end of a set of blocks of duplicate lines.
      Parameters:
        `text` - The text

    - #### endCheck

          void endCheck(CheckSummary summary)

      Called when checking has finished.
      Parameters:
        `summary` -

Copyright (c) 2003-2013 Simon Harris. All rights reserved.