Package com.atlassian.confluence.search.v2

Class SearchFieldMappings.AlternateNames

java.lang.Object
com.atlassian.confluence.search.v2.SearchFieldMappings.AlternateNames
Enclosing class:
SearchFieldMappings
@Deprecated(forRemoval=true) public static final class SearchFieldMappings.AlternateNames extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
This is a temporary solution for backward compatibility purposes, and will be removed in a future version.
Handles alternate names for fields, typically when a field has been split or moved into another field. Needed for backward compatibility reason, so that existing client code can refer to the new field name using the old name, and vice versa (new code against existing index).
Since:
9.0

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable Set<String>
    expand(@Nullable Set<String> fields)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Expand the provided list of names with all of their alternate names
    static <V> Map<String,V>
    expandMap(Map<String,V> fields)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Duplicate the entries of the provided map of fields (key: name) with their alternate field names
    static String
    getActual(String name, Set<String> actualNames)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finds the actual name for the provided name

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • expand

      public static @Nullable Set<String> expand(@Nullable Set<String> fields)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Expand the provided list of names with all of their alternate names
      Parameters:
      fields - the set of field names
      Returns:
      a new set that contains the field names and their alternate names

    • expandMap

      public static <V> Map<String,V> expandMap(Map<String,V> fields)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Duplicate the entries of the provided map of fields (key: name) with their alternate field names
      Parameters:
      fields - the map of fields (key: name)
      Returns:
      a new map that contains the original entries and duplicated entries for their alternate names

    • getActual

      public static String getActual(String name, Set<String> actualNames)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Finds the actual name for the provided name
      Parameters:
      name - a name to match
      actualNames - set of all actual names
      Returns:
      the actual name that matches the given name, defaulted to the given name if none matched