001: /*
002: * $Header: /home/cvs/jakarta-commons/primitives/src/java/org/apache/commons/collections/primitives/FloatCollections.java,v 1.1 2003/10/29 20:07:54 rwaldhoff Exp $
003: * ====================================================================
004: * The Apache Software License, Version 1.1
005: *
006: * Copyright (c) 2003 The Apache Software Foundation. All rights
007: * reserved.
008: *
009: * Redistribution and use in source and binary forms, with or without
010: * modification, are permitted provided that the following conditions
011: * are met:
012: *
013: * 1. Redistributions of source code must retain the above copyright
014: * notice, this list of conditions and the following disclaimer.
015: *
016: * 2. Redistributions in binary form must reproduce the above copyright
017: * notice, this list of conditions and the following disclaimer in
018: * the documentation and/or other materials provided with the
019: * distribution.
020: *
021: * 3. The end-user documentation included with the redistribution, if
022: * any, must include the following acknowledgement:
023: * "This product includes software developed by the
024: * Apache Software Foundation (http://www.apache.org/)."
025: * Alternately, this acknowledgement may appear in the software itself,
026: * if and wherever such third-party acknowledgements normally appear.
027: *
028: * 4. The names "The Jakarta Project", "Commons", and "Apache Software
029: * Foundation" must not be used to endorse or promote products derived
030: * from this software without prior written permission. For written
031: * permission, please contact apache@apache.org.
032: *
033: * 5. Products derived from this software may not be called "Apache"
034: * nor may "Apache" appear in their names without prior written
035: * permission of the Apache Software Foundation.
036: *
037: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
038: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
039: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
040: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
041: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
042: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
043: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
044: * USE, DATA, OR PROFITS; OR BUSINESS FloatERRUPTION) HOWEVER CAUSED AND
045: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
046: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
047: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
048: * SUCH DAMAGE.
049: * ====================================================================
050: *
051: * This software consists of voluntary contributions made by many
052: * individuals on behalf of the Apache Software Foundation. For more
053: * information on the Apache Software Foundation, please see
054: * <http://www.apache.org/>.
055: *
056: */
057:
058: package org.apache.commons.collections.primitives;
059:
060: import org.apache.commons.collections.primitives.decorators.UnmodifiableFloatIterator;
061: import org.apache.commons.collections.primitives.decorators.UnmodifiableFloatList;
062: import org.apache.commons.collections.primitives.decorators.UnmodifiableFloatListIterator;
063:
064: /**
065: * This class consists exclusively of static methods that operate on or
066: * return FloatCollections.
067: * <p>
068: * The methods of this class all throw a NullPoFloaterException if the
069: * provided collection is null.
070: *
071: * @version $Revision: 1.1 $ $Date: 2003/10/29 20:07:54 $
072: *
073: * @author Rodney Waldhoff
074: */
075: public final class FloatCollections {
076:
077: /**
078: * Returns an unmodifiable FloatList containing only the specified element.
079: * @param value the single value
080: * @return an unmodifiable FloatList containing only the specified element.
081: */
082: public static FloatList singletonFloatList(float value) {
083: // TODO: a specialized implementation of FloatList may be more performant
084: FloatList list = new ArrayFloatList(1);
085: list.add(value);
086: return UnmodifiableFloatList.wrap(list);
087: }
088:
089: /**
090: * Returns an unmodifiable FloatIterator containing only the specified element.
091: * @param value the single value
092: * @return an unmodifiable FloatIterator containing only the specified element.
093: */
094: public static FloatIterator singletonFloatIterator(float value) {
095: return singletonFloatList(value).iterator();
096: }
097:
098: /**
099: * Returns an unmodifiable FloatListIterator containing only the specified element.
100: * @param value the single value
101: * @return an unmodifiable FloatListIterator containing only the specified element.
102: */
103: public static FloatListIterator singletonFloatListIterator(
104: float value) {
105: return singletonFloatList(value).listIterator();
106: }
107:
108: /**
109: * Returns an unmodifiable version of the given non-null FloatList.
110: * @param list the non-null FloatList to wrap in an unmodifiable decorator
111: * @return an unmodifiable version of the given non-null FloatList
112: * @throws NullPoFloaterException if the given FloatList is null
113: * @see org.apache.commons.collections.primitives.decorators.UnmodifiableFloatList#wrap
114: */
115: public static FloatList unmodifiableFloatList(FloatList list)
116: throws NullPointerException {
117: if (null == list) {
118: throw new NullPointerException();
119: }
120: return UnmodifiableFloatList.wrap(list);
121: }
122:
123: /**
124: * Returns an unmodifiable version of the given non-null FloatIterator.
125: * @param iter the non-null FloatIterator to wrap in an unmodifiable decorator
126: * @return an unmodifiable version of the given non-null FloatIterator
127: * @throws NullPoFloaterException if the given FloatIterator is null
128: * @see org.apache.commons.collections.primitives.decorators.UnmodifiableFloatIterator#wrap
129: */
130: public static FloatIterator unmodifiableFloatIterator(
131: FloatIterator iter) {
132: if (null == iter) {
133: throw new NullPointerException();
134: }
135: return UnmodifiableFloatIterator.wrap(iter);
136: }
137:
138: /**
139: * Returns an unmodifiable version of the given non-null FloatListIterator.
140: * @param iter the non-null FloatListIterator to wrap in an unmodifiable decorator
141: * @return an unmodifiable version of the given non-null FloatListIterator
142: * @throws NullPoFloaterException if the given FloatListIterator is null
143: * @see org.apache.commons.collections.primitives.decorators.UnmodifiableFloatListIterator#wrap
144: */
145: public static FloatListIterator unmodifiableFloatListIterator(
146: FloatListIterator iter) {
147: if (null == iter) {
148: throw new NullPointerException();
149: }
150: return UnmodifiableFloatListIterator.wrap(iter);
151: }
152:
153: /**
154: * Returns an unmodifiable, empty FloatList.
155: * @return an unmodifiable, empty FloatList.
156: * @see #EMPTY_FLOAT_LIST
157: */
158: public static FloatList getEmptyFloatList() {
159: return EMPTY_FLOAT_LIST;
160: }
161:
162: /**
163: * Returns an unmodifiable, empty FloatIterator
164: * @return an unmodifiable, empty FloatIterator.
165: * @see #EMPTY_FLOAT_ITERATOR
166: */
167: public static FloatIterator getEmptyFloatIterator() {
168: return EMPTY_FLOAT_ITERATOR;
169: }
170:
171: /**
172: * Returns an unmodifiable, empty FloatListIterator
173: * @return an unmodifiable, empty FloatListIterator.
174: * @see #EMPTY_FLOAT_LIST_ITERATOR
175: */
176: public static FloatListIterator getEmptyFloatListIterator() {
177: return EMPTY_FLOAT_LIST_ITERATOR;
178: }
179:
180: /**
181: * An unmodifiable, empty FloatList
182: * @see #getEmptyFloatList
183: */
184: public static final FloatList EMPTY_FLOAT_LIST = unmodifiableFloatList(new ArrayFloatList(
185: 0));
186:
187: /**
188: * An unmodifiable, empty FloatIterator
189: * @see #getEmptyFloatIterator
190: */
191: public static final FloatIterator EMPTY_FLOAT_ITERATOR = unmodifiableFloatIterator(EMPTY_FLOAT_LIST
192: .iterator());
193:
194: /**
195: * An unmodifiable, empty FloatListIterator
196: * @see #getEmptyFloatListIterator
197: */
198: public static final FloatListIterator EMPTY_FLOAT_LIST_ITERATOR = unmodifiableFloatListIterator(EMPTY_FLOAT_LIST
199: .listIterator());
200: }
|