buildframework/helium/sf/java/antcoverage/src/com/nokia/helium/ant/coverage/AntMacros.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
 * All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
 * Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
 * Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
 * Description:  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
package com.nokia.helium.ant.coverage;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
import java.util.Vector;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
 * To store antmacro information.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
public class AntMacros {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
    private Vector<MacroHolder> antMacros = new Vector<MacroHolder>();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
     * To add macro.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
     * @param macro
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
    public void add(String macro) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
        for (MacroHolder mh : antMacros) {
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    34
            if (mh.equals(macro)) {
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
                return;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    36
            }
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
        this.antMacros.add(new MacroHolder(macro));
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
     * To get number of ant macros.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
     * @return
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
    public int getCount() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
        return this.antMacros.size();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
     * To check is the macro present in the list.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
     * @param macroName
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
     * @return
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
    public boolean isMacroPresent(String macroName) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
        return antMacros.contains(macroName);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
     * @param targetName
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
    public void markAsExecuted(String targetName) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
        for (MacroHolder mh : antMacros) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
            if (mh.equals(targetName)) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
                mh.markAsExecuted();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
                return;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
            }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
     * The count of distinct executed target.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
     * @return the number of distinct executed target.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
    public int getExecutedCount() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
        int count = 0;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
        for (MacroHolder mh : antMacros) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
            if (mh.isExecuted()) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
                count++;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
            }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
        return count;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
     * Holder class to contains macro related informations.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
    public class MacroHolder {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
        private String name;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
        private boolean executed;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
        /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
         * Create a scripdef holder.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
         * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
         * @param name
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
         */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
        public MacroHolder(String name) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
            this.name = name;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
        /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   106
         * Is this holder matching a particular object.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   107
         */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   108
        public boolean equals(Object obj) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   109
            return this.name.equals(obj);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   110
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
        /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
         * {@inheritDoc}
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   114
         */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   115
        public int hashCode() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   116
            return super.hashCode();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   117
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   118
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   119
        /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   120
         * Mark as executed.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   121
         */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   122
        public void markAsExecuted() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   123
            this.executed = true;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   124
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   125
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   126
        /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   127
         * As this target been executing?
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   128
         */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   129
        public boolean isExecuted() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   130
            return executed;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   131
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   132
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   133
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   134
}