/*
 * @(#)AbstractMeasure.java
 *
 * Copyright (C) 2003 Matt Albrecht
 * groboclown@users.sourceforge.net
 * http://groboutils.sourceforge.net
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a
 *  copy of this software and associated documentation files (the "Software"),
 *  to deal in the Software without restriction, including without limitation
 *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
 *  and/or sell copies of the Software, and to permit persons to whom the 
 *  Software is furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in 
 *  all copies or substantial portions of the Software. 
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL 
 *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 *  DEALINGS IN THE SOFTWARE.
 */

package net.sourceforge.groboutils.codecoverage.v2.module;


import java.util.HashSet;
import java.util.Set;

import net.sourceforge.groboutils.codecoverage.v2.IAnalysisMetaData;
import net.sourceforge.groboutils.codecoverage.v2.IAnalysisModule;
import net.sourceforge.groboutils.codecoverage.v2.IMethodCode;

/**
 * Offers additional capability to detect when a probe has been measured
 * more than once.
 *
 * @author    Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
 * @version   $Date: 2004/04/15 05:48:26 $
 * @since     January 26, 2003
 * @see       IAnalysisMetaData
 */
public abstract class AbstractMeasure implements IAnalysisModule
{
    private Set beenCovered = new HashSet();
    
    protected void markInstruction( IMethodCode method, int instrPos,
            IAnalysisMetaData data, boolean allowDuplicates )
    {
        boolean addMark = true;
        if (!allowDuplicates)
        {
            String id = getPositionID( method, instrPos );
            if (this.beenCovered.contains( id ))
            {
                addMark = false;
            }
            else
            {
                this.beenCovered.add( id );
            }
        }
        
        if (addMark)
        {
            method.markInstruction( instrPos, data );
        }
    }
    
    
    private String getPositionID( IMethodCode m, int instrPos )
    {
        StringBuffer sb = new StringBuffer( m.getClassName() );
        sb.append( '#' ).append( m.getMethodName() );
        sb.append( '#' ).append( instrPos );
        
        // more memory conservative
        return new String( sb );
    }
}

