Ignore:
Timestamp:
09/20/12 09:40:26 (12 years ago)
Author:
sherbold
Message:
  • code documentation and clean-up
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/quest-core-events/src/main/java/de/ugoe/cs/quest/eventcore/guimodel/IGUIElementSpec.java

    r778 r831  
     1 
    12package de.ugoe.cs.quest.eventcore.guimodel; 
    23 
    … …  
    56/** 
    67 * <p> 
    7  * TODO comment 
     8 * Common interface for GUI element specifications. 
    89 * </p> 
    910 *  
    10  * @version $Revision: $ $Date: 17.08.2012$ 
    11  * @author 2012, last modified by $Author: pharms$ 
     11 * @version 1.0 
     12 * @author Patrick Harms 
    1213 */ 
    1314public interface IGUIElementSpec extends Serializable { 
    … …  
    1516    /** 
    1617     * <p> 
    17      * TODO: comment 
     18     * Returns a string represenation of the GUI element type that this specification represents. 
    1819     * </p> 
    19      * 
     20     *  
    2021     * @return 
    2122     */ 
    2223    public String getType(); 
    23      
     24 
    2425    /** 
    2526     * <p> 
    26      * TODO: comment 
     27     * Evaluates if two GUI specifications are similar. Similar means that a heuristic determines 
     28     * that the two GUI specifications describe the same GUI element. 
    2729     * </p> 
    28      * 
     30     *  
    2931     * @param other 
    30      * @return 
     32     *            specification whose similarity to this is evaluated 
     33     * @return true if the specifications are similar; false otherwise 
    3134     */ 
    3235    public boolean getSimilarity(IGUIElementSpec other); 
    … …  
    3437    /** 
    3538     * <p> 
    36      * TODO: comment 
     39     * Defines that {@link IGUIElement} implementations have to define equals. 
    3740     * </p> 
    38      * 
    39      * @param other 
    40      * @return 
     41     *  
     42     * @see Object#equals(Object) 
    4143     */ 
    42     public boolean equals(IGUIElementSpec other); 
    43      
     44    @Override 
     45    public boolean equals(Object other); 
     46 
    4447    /** 
    4548     * <p> 
    46      * TODO: comment 
     49     * Defines that {@link IGUIElement} implementations have to define hashCode. 
    4750     * </p> 
    48      * 
    49      * @return 
     51     *  
     52     * @see Object#hashCode() 
    5053     */ 
     54    @Override 
    5155    public int hashCode(); 
    5256} 
Note: See TracChangeset for help on using the changeset viewer.