Package org.alfresco.repo.search.impl.lucene.index

Enum IndexType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<IndexType>
    public enum IndexType
extends java.lang.Enum<IndexType>
    The type of an entry in this index.
    Author:
    Andy Hind

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DELTA
      An overlay.
      INDEX
      Identifies the main index.
      OVERLAY
      A long running overlay definition against the index.
      OVERLAY_DELTA  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static IndexType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static IndexType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • INDEX

        public static final IndexType INDEX
        Identifies the main index. This is always a fully optimised index.

      • DELTA

        public static final IndexType DELTA
        An overlay. This is an optimised index with a deletion list. To commit an overlay requires no deletions against other indexes. Deletions are done when an overlay turns into or is merged into a index. Overlays are periodically merged into an index. An overlay can require or have background properties indexed.

      • OVERLAY

        public static final IndexType OVERLAY
        A long running overlay definition against the index. Not yet supported. This, itself, may have transactional additions.

      • OVERLAY_DELTA

        public static final IndexType OVERLAY_DELTA

    • Method Detail

      • values

        public static IndexType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (IndexType c : IndexType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static IndexType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null