如何在Java中按字母顺序对枚举成员进行排序?

时间:2009-11-14 17:08:56

标签: java sorting enums comparator alphabetical

我有一个类似以下的枚举类:

public enum Letter {
    OMEGA_LETTER("Omega"), 
    GAMMA_LETTER("Gamma"), 
    BETA_LETTER("Beta"), 
    ALPHA_LETTER("Alpha"), 

    private final String description;

    Letter() {
      description = toString();
    }

    Letter(String description) {
      this.description = description;
    }

    public String getDescription() {
      return description;
    }
}

稍后我的代码我基本上迭代了字母enum并将其成员打印到控制台:

for (Letter letter : Letter.values()) {
System.out.println(letter.getDescription());
}

我认为values()方法会给我一个枚举的有序视图(如前所述here),但这不是这里的情况。我只是按照我在Letter枚举类中创建它们的顺序获取枚举成员。有没有办法按字母顺序输出枚举值?我需要一个单独的比较器对象,还是有内置的方法来做到这一点?基本上我希望根据getDescription()文本按字母顺序对值进行排序:

Alpha
Beta
Gamma
Omega

5 个答案:

答案 0 :(得分:19)

SortedMap<String, Letter> map = new TreeMap<String, Letter>();
for (Letter l : Letter.values()) {
    map.put(l.getDescription, l);
}
return map.values();

或者只是重新排序声明: - )

编辑:正如KLE指出的那样,这假设描述在枚举中是唯一的。

答案 1 :(得分:6)

  

我认为values()方法会给我一个enum的有序视图(如这里所提到的),但这不是这里的情况。我只是按照我在Letter枚举类中创建它们的顺序获取枚举成员。

准确地说,声明的顺序对于枚举来说是重要的,所以我们很高兴它们按照这个顺序返回。例如,当int i表示枚举值时,执行values()[i]是查找枚举实例的一种非常简单有效的方法。相反,ordinal()方法返回枚举实例的索引。

  

有没有办法按字母顺序输出枚举值?我需要一个单独的比较器对象,还是有内置的方法来做到这一点?基本上我希望根据getDescription()文本按字母顺序对值进行排序:

您所谓的 value 不是通常为枚举定义的内容。在您的上下文中,您指的是getDescription()

的结果

正如您所说,您可以为这些说明创建比较器。那将是完美的: - )


请注意,一般来说,您可能需要多个订单才能使用这些实例

  • 申报单(这是官方订单)
  • 说明顺序
  • 根据需要
  • 其他人

您还可以稍微强调一下DescriptionComparator的概念:

  1. 出于性能原因,您可以存储计算出的描述。

  2. 因为枚举不能继承,所以代码重用必须在枚举类之外。让我举一个我们将在项目中使用的例子:

  3. 现在代码示例......

    /** Interface for enums that have a description. */
    public interface Described {
      /** Returns the description. */
      String getDescription();
    }
    
    public enum Letter implements Described {
      // .... implementation as in the original post, 
      // as the method is already implemented
    }
    
    public enum Other implements Described {
      // .... same
    }
    
    /** Utilities for enums. */
    public abstract class EnumUtils {
    
      /** Reusable Comparator instance for Described objects. */
      public static Comparator<Described> DESCRIPTION_COMPARATOR = 
        new Comparator<Described>() {
          public int compareTo(Described a, Described b) {
            return a.getDescription().compareTo(b.getDescription);
          }
        };
    
      /** Return the sorted descriptions for the enum. */
      public static <E extends Enum & Described> List<String> 
        getSortedDescriptions(Class<E> enumClass) {
          List<String> descriptions = new ArrayList<String>();
          for(E e : enumClass.getEnumConstants()) {
            result.add(e.getDescription());
          }
          Collections.sort(descriptions);
          return descriptions;
      }
    }
    
    // caller code
    List<String> letters = EnumUtils.getSortedDescriptions(Letter.class);
    List<String> others = EnumUtils.getSortedDescriptions(Other.class);
    

    请注意EnumUtils中的通用代码不仅适用于一个枚举类,而适用于项目中实现Described接口的任何枚举类。

    如前所述,将代码置于枚举之外(否则将属于其中)的重点是重用代码。这对于两个枚举来说并不是什么大不了的事,但我们的项目中有超过一千个枚举,其中很多都有相同的界面......!

答案 2 :(得分:5)

只需使用Arrays.sort和您自己的比较器对它们进行排序。

答案 3 :(得分:0)

这是一种通用方法,可以在任何类中执行它,而无需在要排序的类上实现Comparable或创建自定义比较器。我发现了一些我不想覆盖compareTo的实例,因为它有不同的用途,你无论如何都不能用于枚举,并且不断创建包装类是一件痛苦的事。您可以传入一个函数,该函数输出您想要用于排序目的的Comparable对象。

toComparable函数仅在列表中的每个元素中调用一次(对于自定义比较器而言不是这样),因此如果某个类的调用很昂贵,则特别好。空值在内部处理,因此比自定义比较器更容易使用。对Java 7的TimSort算法的一次调用比对一系列O(log N)插入到SortedMap(红黑树或其他平衡树实现)的效率要高得多。并且您不限于任何特定的类或接口。

在许多情况下,真实世界的性能提升非常重要。例如,在大小为100k的列表上使用toString()对Doubles进行排序时,性能提升的速度是使用比较器的5倍。

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.ListIterator;

public class GenericLetterSorter {
    public enum Letter {
        OMEGA_LETTER("Omega"), 
        GAMMA_LETTER("Gamma"), 
        BETA_LETTER("Beta"), 
        ALPHA_LETTER("Alpha"); 

        private final String description;

        Letter() {
          description = toString();
        }

        Letter(String description) {
          this.description = description;
        }

        public String getDescription() {
          return description;
        }
    }

public static void main(String[] args) {
    List<Letter> list = new ArrayList<>(Arrays.asList(Letter.values()));

    sort(list, new ToComparable<Letter>() {
        @Override
        public Comparable toComparable(Letter letter) {
            // sort based on the letter's description
            return letter == null ? null : letter.getDescription();
        }
    });

    for (Letter letter : list)
        System.out.println(letter == null ? null : letter.name());
}

    public interface ToComparable<T, C extends Comparable<? super C>> {
         C toComparable(T t);
    }

    public static <T, C extends Comparable<? super C>> void sort(List<T> list, ToComparable<T, C> function) {
       class Pair implements Comparable<Pair> {
          final T original;
          final C comparable;

          Pair(T original, C comparable) {
             this.original = original;
             this.comparable = comparable;
          }

          @Override
          public int compareTo(Pair other) {
                return
                  comparable == null && other.comparable == null ? 0 :
                  comparable == null ? -1 :
                  other.comparable == null ? 1 :
                  comparable.compareTo(other.comparable);
          }
       }

       List<Pair> pairs = new ArrayList<>(list.size());
       for (T original : list)
          pairs.add(new Pair(original, function.toComparable(original)));

       Collections.sort(pairs);

       ListIterator<T> iter = list.listIterator();
       for (Pair pair : pairs) {
          iter.next();
          iter.set(pair.original);
       }
    }
}

答案 4 :(得分:0)

你可以在java8中使用带有比较器的排序函数

enumlist.stream()
.sorted(Comparator.comparing(Enum::toString)).collect(Collectors.toList());