001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.batch.duplication;
021    
022    import org.sonar.api.BatchComponent;
023    import org.sonar.batch.index.Cache;
024    import org.sonar.batch.index.Cache.Entry;
025    import org.sonar.batch.index.Caches;
026    import org.sonar.duplications.block.FileBlocks;
027    
028    import javax.annotation.CheckForNull;
029    
030    /**
031     * Cache of duplication blocks. This cache is shared amongst all project modules.
032     */
033    public class BlockCache implements BatchComponent {
034    
035      private final Cache<FileBlocks> cache;
036    
037      public BlockCache(Caches caches) {
038        caches.registerValueCoder(FileBlocks.class, new FileBlocksValueCoder());
039        cache = caches.createCache("blocks");
040      }
041    
042      public Iterable<Entry<FileBlocks>> entries() {
043        return cache.entries();
044      }
045    
046      @CheckForNull
047      public FileBlocks byComponent(String effectiveKey) {
048        return cache.get(effectiveKey);
049      }
050    
051      public BlockCache put(String effectiveKey, FileBlocks blocks) {
052        cache.put(effectiveKey, blocks);
053        return this;
054      }
055    
056    }