Interface IndexInfoService

  • All Known Implementing Classes:
    IndexInfoServiceImpl

    @ProviderType
    public interface IndexInfoService
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Iterable<IndexInfo> getAllIndexInfo()
      Returns IndexInfo for all the indexes present in the repository
      @Nullable IndexInfo getInfo​(java.lang.String indexPath)
      Returns IndexInfo for index at given path
      boolean isValid​(java.lang.String indexPath)
      Determined if the index is valid and usable.
    • Method Detail

      • getAllIndexInfo

        java.lang.Iterable<IndexInfo> getAllIndexInfo()
        Returns IndexInfo for all the indexes present in the repository
      • getInfo

        @Nullable
        @Nullable IndexInfo getInfo​(java.lang.String indexPath)
                             throws java.io.IOException
        Returns IndexInfo for index at given path
        Parameters:
        indexPath - path repository
        Returns:
        indexInfo for the index or null if there is no index node found at given path
        Throws:
        java.io.IOException
      • isValid

        boolean isValid​(java.lang.String indexPath)
                 throws java.io.IOException
        Determined if the index is valid and usable. If the index is corrupt then it returns false
        Throws:
        java.io.IOException