Package com.attivio.sdk.search

Enum HighlightMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<HighlightMode>
    public enum HighlightMode
extends java.lang.Enum<HighlightMode>
implements java.io.Serializable

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      HTML
      Scopes will be annotated using <span> elements with the class attribute set to the scope name.
      RAW
      Raw text will be returned.
      TEXT
      Unannotated text will be returned.
      XML
      Scopes will be annotated using xml elements.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HighlightMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HighlightMode[] 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

      • RAW

        public static final HighlightMode RAW
        Raw text will be returned.

      • TEXT

        public static final HighlightMode TEXT
        Unannotated text will be returned.

      • XML

        public static final HighlightMode XML
        Scopes will be annotated using xml elements.

      • HTML

        public static final HighlightMode HTML
        Scopes will be annotated using <span> elements with the class attribute set to the scope name.

    • Method Detail

      • values

        public static HighlightMode[] 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 (HighlightMode c : HighlightMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HighlightMode 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