001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.collections.primitives;
018    
019    import org.apache.commons.collections.primitives.decorators.UnmodifiableFloatIterator;
020    import org.apache.commons.collections.primitives.decorators.UnmodifiableFloatList;
021    import org.apache.commons.collections.primitives.decorators.UnmodifiableFloatListIterator;
022    
023    /**
024     * This class consists exclusively of static methods that operate on or
025     * return FloatCollections.
026     * <p>
027     * The methods of this class all throw a NullPoFloaterException if the 
028     * provided collection is null.
029     * 
030     * @version $Revision: 480460 $ $Date: 2006-11-29 09:14:21 +0100 (Wed, 29 Nov 2006) $
031     * 
032     * @author Rodney Waldhoff 
033     */
034    public final class FloatCollections {
035    
036        /**
037         * Returns an unmodifiable FloatList containing only the specified element.
038         * @param value the single value
039         * @return an unmodifiable FloatList containing only the specified element.
040         */    
041        public static FloatList singletonFloatList(float value) {
042            // TODO: a specialized implementation of FloatList may be more performant
043            FloatList list = new ArrayFloatList(1);
044            list.add(value);
045            return UnmodifiableFloatList.wrap(list);
046        }
047    
048        /**
049         * Returns an unmodifiable FloatIterator containing only the specified element.
050         * @param value the single value
051         * @return an unmodifiable FloatIterator containing only the specified element.
052         */    
053        public static FloatIterator singletonFloatIterator(float value) {
054            return singletonFloatList(value).iterator();
055        }
056    
057        /**
058         * Returns an unmodifiable FloatListIterator containing only the specified element.
059         * @param value the single value
060         * @return an unmodifiable FloatListIterator containing only the specified element.
061         */    
062        public static FloatListIterator singletonFloatListIterator(float value) {
063            return singletonFloatList(value).listIterator();
064        }
065    
066        /**
067         * Returns an unmodifiable version of the given non-null FloatList.
068         * @param list the non-null FloatList to wrap in an unmodifiable decorator
069         * @return an unmodifiable version of the given non-null FloatList
070         * @throws NullPointerException if the given FloatList is null
071         * @see org.apache.commons.collections.primitives.decorators.UnmodifiableFloatList#wrap
072         */    
073        public static FloatList unmodifiableFloatList(FloatList list) throws NullPointerException {
074            if(null == list) {
075                throw new NullPointerException();
076            }
077            return UnmodifiableFloatList.wrap(list);
078        }
079        
080        /**
081         * Returns an unmodifiable version of the given non-null FloatIterator.
082         * @param iter the non-null FloatIterator to wrap in an unmodifiable decorator
083         * @return an unmodifiable version of the given non-null FloatIterator
084         * @throws NullPointerException if the given FloatIterator is null
085         * @see org.apache.commons.collections.primitives.decorators.UnmodifiableFloatIterator#wrap
086         */    
087        public static FloatIterator unmodifiableFloatIterator(FloatIterator iter) {
088            if(null == iter) {
089                throw new NullPointerException();
090            }
091            return UnmodifiableFloatIterator.wrap(iter);
092        }
093            
094        /**
095         * Returns an unmodifiable version of the given non-null FloatListIterator.
096         * @param iter the non-null FloatListIterator to wrap in an unmodifiable decorator
097         * @return an unmodifiable version of the given non-null FloatListIterator
098         * @throws NullPointerException if the given FloatListIterator is null
099         * @see org.apache.commons.collections.primitives.decorators.UnmodifiableFloatListIterator#wrap
100         */    
101        public static FloatListIterator unmodifiableFloatListIterator(FloatListIterator iter) {
102            if(null == iter) {
103                throw new NullPointerException();
104            }
105            return UnmodifiableFloatListIterator.wrap(iter);
106        }
107        
108        /**
109         * Returns an unmodifiable, empty FloatList.
110         * @return an unmodifiable, empty FloatList.
111         * @see #EMPTY_FLOAT_LIST
112         */    
113        public static FloatList getEmptyFloatList() {
114            return EMPTY_FLOAT_LIST;
115        }
116        
117        /**
118         * Returns an unmodifiable, empty FloatIterator
119         * @return an unmodifiable, empty FloatIterator.
120         * @see #EMPTY_FLOAT_ITERATOR
121         */    
122        public static FloatIterator getEmptyFloatIterator() {
123            return EMPTY_FLOAT_ITERATOR;
124        }
125        
126        /**
127         * Returns an unmodifiable, empty FloatListIterator
128         * @return an unmodifiable, empty FloatListIterator.
129         * @see #EMPTY_FLOAT_LIST_ITERATOR
130         */    
131        public static FloatListIterator getEmptyFloatListIterator() {
132            return EMPTY_FLOAT_LIST_ITERATOR;
133        }    
134    
135        /**
136         * An unmodifiable, empty FloatList
137         * @see #getEmptyFloatList
138         */    
139        public static final FloatList EMPTY_FLOAT_LIST = unmodifiableFloatList(new ArrayFloatList(0));
140    
141        /**
142         * An unmodifiable, empty FloatIterator
143         * @see #getEmptyFloatIterator
144         */    
145        public static final FloatIterator EMPTY_FLOAT_ITERATOR = unmodifiableFloatIterator(EMPTY_FLOAT_LIST.iterator());
146    
147        /**
148         * An unmodifiable, empty FloatListIterator
149         * @see #getEmptyFloatListIterator
150         */    
151        public static final FloatListIterator EMPTY_FLOAT_LIST_ITERATOR = unmodifiableFloatListIterator(EMPTY_FLOAT_LIST.listIterator());
152    }