guideme.indices.UniqueIndex<K,V>

public class UniqueIndex<K,V> extends Object implements PageIndex

Maintains an index for any given page using a mapping function for keys and values of the index.

Constructor Details
- UniqueIndex
  
  public UniqueIndex(String name, UniqueIndex.EntryFunction<K,V> entryFunction, PageIndex.JsonSerializer<K> keySerializer, PageIndex.JsonSerializer<V> valueSerializer)
Method Details
- getName
  
  public String getName()
  
  Specified by:
  
  getName in interface PageIndex
- get
  
  @Nullable public V get(K key)
- supportsUpdate
  
  public boolean supportsUpdate()
  
  Specified by:
  
  supportsUpdate in interface PageIndex
  
  Returns:
  
  True if this index supports incremental updates via the PageIndex.update(java.util.List<guideme.compiler.ParsedGuidePage>, java.util.List<guideme.GuidePageChange>) method.
- rebuild
  
  public void rebuild(List<ParsedGuidePage> pages)
  
  Description copied from interface: PageIndex
  
  Fully rebuilds this index.
  
  Specified by:
  
  rebuild in interface PageIndex
- update
  
  public void update(List<ParsedGuidePage> allPages, List<GuidePageChange> changes)
  
  Description copied from interface: PageIndex
  
  Applies an incremental update to this index.
  
  Specified by:
  
  update in interface PageIndex
- export
  
  public void export(com.google.gson.stream.JsonWriter writer) throws IOException
  
  Description copied from interface: PageIndex
  
  Serialize the index to JSON for export to the website.
  
  Specified by:
  
  export in interface PageIndex
  
  Throws:
  
  IOException

Class UniqueIndex<K,V>

Nested Class Summary