001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.duplications.index;
021    
022    import java.util.Collection;
023    
024    import org.sonar.duplications.block.Block;
025    import org.sonar.duplications.block.ByteArray;
026    
027    public interface CloneIndex {
028    
029      /**
030       * Performs search of blocks for specified resource.
031       * 
032       * @return collection of blocks from index for specified resource and empty collection if nothing found
033       */
034      Collection<Block> getByResourceId(String resourceId);
035    
036      /**
037       * Performs search of blocks for specified hash value.
038       * 
039       * @return collection of blocks from index with specified hash and empty collection if nothing found
040       */
041      Collection<Block> getBySequenceHash(ByteArray hash);
042    
043      /**
044       * Adds specified block into index.
045       */
046      void insert(Block block);
047    
048    }