Двунаправленные карты Гуавы

Google Guava может многое предложить разработчику Java, работающему с J2SE 5 , Java SE 6 или Java SE 7 . Чем старше их версия, тем полезнее может быть Guava. Хотя Java SE 7 предоставляет некоторые функции, предоставляемые Guava, языку программирования Java в качестве стандартной части языка (например, новый класс Objects ), по-прежнему существует множество функций Guava, которые недоступны даже в JDK 7. В этом посте Я сосредоточен на поддержке двунаправленных карт в Гуаве .

Наследие Гуавы находится в « древнем и не поддерживаемом » проекте Google Collections, и поддержка двунаправленной карты Гуавы происходит из этого наследия Google Collections . Документация API для интерфейса com.google.common.collect.BiMap в Guava предоставляет хорошее краткое определение двунаправленной карты:

Двунаправленная карта (или «двунаправленная карта») — это карта, которая сохраняет уникальность своих значений, а также ключей. Это ограничение позволяет бимапам поддерживать «инверсное представление», которое является еще одним бимапом, содержащим те же записи, что и этот бимап, но с обращенными ключами и значениями.

В моей карьере я столкнулся с несколькими ситуациями, когда поддержка двунаправленной карты помогает сделать более понятный и читаемый код. Я даже построил пользовательские реализации двунаправленных карт, но больше не делать , что благодаря наличию гуавы (и ранее в Google Коллекции и Apache Commons «ы BidiMap). Следующий листинг кода показывает простую ситуацию, когда двунаправленная карта полезна. Этот пример отображает нации в их столицы. Прелесть двунаправленной карты в том, что я могу искать столицу по названию ее нации или я могу искать по названию нации по названию столицы. Важной характеристикой двунаправленной карты является то, что сторона «значения» двунаправленной карты требует уникальных значений в дополнение к более типичной «ключевой» стороне двунаправленной карты, требующей уникальных значений.

TwoMonoDirectionalMaps

package dustin.examples;

import static java.lang.System.out;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * Demonstrate simplistic implementation of functionality equivalent to that
 * provided by bidirectional map via two monodirectional maps. This class has
 * some intentional problems to illustrate the maintenance disadvantages of this
 * approach. For example, there is a mismatch between the two single-direction
 * maps for "London" (UK in one case and England in the other case) and the
 * mapping for France/Paris was left off one of the single-direction maps.
 * 
 * @author Dustin
 */
public class TwoMonoDirectionalMaps
{
   private final static Map<String, String> nationsToCapitals;
   private final static Map<String, String> capitalsToNations;

   static
   {
      final Map<String, String> tempNationsToCapitals = new HashMap<String, String>();
      tempNationsToCapitals.put("Canada", "Ottawa");
      tempNationsToCapitals.put("England", "London");
      tempNationsToCapitals.put("France", "Paris");
      tempNationsToCapitals.put("Mexico", "Mexico City");
      tempNationsToCapitals.put("Portugal", "Lisbon");
      tempNationsToCapitals.put("Spain", "Madrid");
      tempNationsToCapitals.put("United States", "Washington");
      nationsToCapitals = Collections.unmodifiableMap(tempNationsToCapitals);

      final Map<String, String> tempCapitalsToNations = new HashMap<String, String>();
      tempCapitalsToNations.put("Lisbon", "Portugal");
      tempCapitalsToNations.put("London", "United Kingdom");
      tempCapitalsToNations.put("Madrid", "Spain");
      tempCapitalsToNations.put("Mexico City", "Mexico");
      tempCapitalsToNations.put("Ottawa", "Canada");
      tempCapitalsToNations.put("Washington", "United States");
      capitalsToNations = Collections.unmodifiableMap(tempCapitalsToNations);
   }

   /**
    * Print the capital city of the nation whose name is provided.
    * 
    * @param nationName Name of nation for which capital is decided.
    */
   public void printCapitalOfNation(final String nationName)
   {
      out.println(
           "The capital of " + nationName + " is "
         + (nationsToCapitals.containsKey(nationName) ? nationsToCapitals.get(nationName) : "unknown" )
         + ".");
   }

   /**
    * Print the name of the nation whose capital name is provided.
    * 
    * @param capitalName Name of capital city for which nation is desired.
    */
   public void printNationOfCapital(final String capitalName)
   {
      out.println(
           capitalName + " is the the capital of "
         + (capitalsToNations.containsKey(capitalName) ? capitalsToNations.get(capitalName) : "unknown" )
         + ".");
   }

   /**
    * Main function demonstrating this use of two mono-directional maps.
    * 
    * @param arguments Command-line arguments; none expected.
    */
   public static void main(final String[] arguments)
   {
      final TwoMonoDirectionalMaps me = new TwoMonoDirectionalMaps();
      me.printCapitalOfNation("United States");
      me.printCapitalOfNation("England");
      me.printCapitalOfNation("France");
      me.printNationOfCapital("Washington");
      me.printNationOfCapital("London");
      me.printNationOfCapital("Paris");
   }
}