001/* 002 * Copyright (C) 2008 The Guava Authors 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package com.google.common.collect.testing.google; 018 019import static java.util.Collections.sort; 020 021import com.google.common.annotations.GwtCompatible; 022import com.google.common.collect.Multiset; 023import com.google.common.collect.testing.AnEnum; 024import com.google.common.collect.testing.SampleElements; 025import com.google.common.collect.testing.SampleElements.Enums; 026import java.util.List; 027import org.jspecify.annotations.NullMarked; 028 029/** 030 * An abstract {@code TestMultisetGenerator} for generating multisets containing enum values. 031 * 032 * @author Jared Levy 033 */ 034@GwtCompatible 035@NullMarked 036public abstract class TestEnumMultisetGenerator implements TestMultisetGenerator<AnEnum> { 037 @Override 038 public SampleElements<AnEnum> samples() { 039 return new Enums(); 040 } 041 042 @Override 043 public Multiset<AnEnum> create(Object... elements) { 044 AnEnum[] array = new AnEnum[elements.length]; 045 int i = 0; 046 for (Object e : elements) { 047 array[i++] = (AnEnum) e; 048 } 049 return create(array); 050 } 051 052 protected abstract Multiset<AnEnum> create(AnEnum[] elements); 053 054 @Override 055 public AnEnum[] createArray(int length) { 056 return new AnEnum[length]; 057 } 058 059 /** Sorts the enums according to their natural ordering. */ 060 /* 061 * While the current implementation returns `this`, that's not something we mean to guarantee. 062 * Callers of TestContainerGenerator.order need to be prepared for implementations to return a new 063 * collection. 064 */ 065 @SuppressWarnings("CanIgnoreReturnValueSuggester") 066 @Override 067 public List<AnEnum> order(List<AnEnum> insertionOrder) { 068 sort(insertionOrder); 069 return insertionOrder; 070 } 071}