• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2008 The Guava Authors
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.google.common.collect.testing;
18 
19 import com.google.common.annotations.GwtCompatible;
20 import java.util.Collections;
21 import java.util.EnumSet;
22 import java.util.Iterator;
23 import java.util.ListIterator;
24 import java.util.Set;
25 
26 /**
27  * A method supported by implementations of the {@link Iterator} or {@link ListIterator} interface.
28  *
29  * <p>This enum is GWT compatible.
30  *
31  * @author Chris Povirk
32  */
33 @GwtCompatible
34 public enum IteratorFeature {
35   /** Support for {@link Iterator#remove()}. */
36   SUPPORTS_REMOVE,
37   /**
38    * Support for {@link ListIterator#add(Object)}; ignored for plain {@link Iterator}
39    * implementations.
40    */
41   SUPPORTS_ADD,
42   /**
43    * Support for {@link ListIterator#set(Object)}; ignored for plain {@link Iterator}
44    * implementations.
45    */
46   SUPPORTS_SET;
47 
48   /**
49    * A set containing none of the optional features of the {@link Iterator} or {@link ListIterator}
50    * interfaces.
51    */
52   public static final Set<IteratorFeature> UNMODIFIABLE = Collections.emptySet();
53 
54   /**
55    * A set containing all of the optional features of the {@link Iterator} and {@link ListIterator}
56    * interfaces.
57    */
58   public static final Set<IteratorFeature> MODIFIABLE =
59       Collections.unmodifiableSet(EnumSet.allOf(IteratorFeature.class));
60 }
61