1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*
* Copyright (C) 2002-2014 Sebastiano Vigna
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package PACKAGE;
import java.util.Collection;
/** A type-specific {@link Collection}; provides some additional methods
* that use polymorphism to avoid (un)boxing.
*
* <P>Additionally, this class defines strengthens (again) {@link #iterator()} and defines
* a slightly different semantics for {@link #toArray(Object[])}.
*
* @see Collection
*/
public interface COLLECTION KEY_GENERIC extends Collection<KEY_GENERIC_CLASS>, KEY_ITERABLE KEY_GENERIC {
/** Returns a type-specific iterator on the elements of this collection.
*
* <p>Note that this specification strengthens the one given in
* {@link java.lang.Iterable#iterator()}, which was already
* strengthened in the corresponding type-specific class,
* but was weakened by the fact that this interface extends {@link Collection}.
*
* @return a type-specific iterator on the elements of this collection.
*/
KEY_ITERATOR KEY_GENERIC iterator();
/** Returns a type-specific iterator on this elements of this collection.
*
* @see #iterator()
* @deprecated As of <code>fastutil</code> 5, replaced by {@link #iterator()}.
*/
@Deprecated
KEY_ITERATOR KEY_GENERIC KEY_ITERATOR_METHOD();
/** Returns an containing the items of this collection;
* the runtime type of the returned array is that of the specified array.
*
* <p><strong>Warning</strong>: Note that, contrarily to {@link Collection#toArray(Object[])}, this
* methods just writes all elements of this collection: no special
* value will be added after the last one.
*
* @param a if this array is big enough, it will be used to store this collection.
* @return a primitive type array containing the items of this collection.
* @see Collection#toArray(Object[])
*/
<T> T[] toArray(T[] a);
#if #keys(primitive)
/**
* @see Collection#contains(Object)
*/
boolean contains( KEY_TYPE key );
/** Returns a primitive type array containing the items of this collection.
* @return a primitive type array containing the items of this collection.
* @see Collection#toArray()
*/
KEY_TYPE[] TO_KEY_ARRAY();
/** Returns a primitive type array containing the items of this collection.
*
* <p>Note that, contrarily to {@link Collection#toArray(Object[])}, this
* methods just writes all elements of this collection: no special
* value will be added after the last one.
*
* @param a if this array is big enough, it will be used to store this collection.
* @return a primitive type array containing the items of this collection.
* @see Collection#toArray(Object[])
*/
KEY_TYPE[] TO_KEY_ARRAY( KEY_TYPE a[] );
/** Returns a primitive type array containing the items of this collection.
*
* <p>Note that, contrarily to {@link Collection#toArray(Object[])}, this
* methods just writes all elements of this collection: no special
* value will be added after the last one.
*
* @param a if this array is big enough, it will be used to store this collection.
* @return a primitive type array containing the items of this collection.
* @see Collection#toArray(Object[])
*/
KEY_TYPE[] toArray( KEY_TYPE a[] );
/**
* @see Collection#add(Object)
*/
boolean add( KEY_TYPE key );
/** Note that this method should be called {@link java.util.Collection#remove(Object) remove()}, but the clash
* with the similarly named index-based method in the {@link java.util.List} interface
* forces us to use a distinguished name. For simplicity, the set interfaces reinstates
* <code>remove()</code>.
*
* @see Collection#remove(Object)
*/
boolean rem( KEY_TYPE key );
/**
* @see Collection#addAll(Collection)
*/
boolean addAll( COLLECTION c );
/**
* @see Collection#containsAll(Collection)
*/
boolean containsAll( COLLECTION c );
/**
* @see Collection#removeAll(Collection)
*/
boolean removeAll( COLLECTION c );
/**
* @see Collection#retainAll(Collection)
*/
boolean retainAll( COLLECTION c );
#endif
}
|
