001: /*
002: * $Header: /home/cvs/jakarta-commons/primitives/src/java/org/apache/commons/collections/primitives/ShortCollections.java,v 1.1 2003/10/29 18:57:15 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 ShortERRUPTION) 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.UnmodifiableShortIterator;
061: import org.apache.commons.collections.primitives.decorators.UnmodifiableShortList;
062: import org.apache.commons.collections.primitives.decorators.UnmodifiableShortListIterator;
063:
064: /**
065: * This class consists exclusively of static methods that operate on or
066: * return ShortCollections.
067: * <p>
068: * The methods of this class all throw a NullPoShorterException if the
069: * provided collection is null.
070: *
071: * @version $Revision: 1.1 $ $Date: 2003/10/29 18:57:15 $
072: *
073: * @author Rodney Waldhoff
074: */
075: public final class ShortCollections {
076:
077: /**
078: * Returns an unmodifiable ShortList containing only the specified element.
079: * @param value the single value
080: * @return an unmodifiable ShortList containing only the specified element.
081: */
082: public static ShortList singletonShortList(short value) {
083: // TODO: a specialized implementation of ShortList may be more performant
084: ShortList list = new ArrayShortList(1);
085: list.add(value);
086: return UnmodifiableShortList.wrap(list);
087: }
088:
089: /**
090: * Returns an unmodifiable ShortIterator containing only the specified element.
091: * @param value the single value
092: * @return an unmodifiable ShortIterator containing only the specified element.
093: */
094: public static ShortIterator singletonShortIterator(short value) {
095: return singletonShortList(value).iterator();
096: }
097:
098: /**
099: * Returns an unmodifiable ShortListIterator containing only the specified element.
100: * @param value the single value
101: * @return an unmodifiable ShortListIterator containing only the specified element.
102: */
103: public static ShortListIterator singletonShortListIterator(
104: short value) {
105: return singletonShortList(value).listIterator();
106: }
107:
108: /**
109: * Returns an unmodifiable version of the given non-null ShortList.
110: * @param list the non-null ShortList to wrap in an unmodifiable decorator
111: * @return an unmodifiable version of the given non-null ShortList
112: * @throws NullPoShorterException if the given ShortList is null
113: * @see org.apache.commons.collections.primitives.decorators.UnmodifiableShortList#wrap
114: */
115: public static ShortList unmodifiableShortList(ShortList list)
116: throws NullPointerException {
117: if (null == list) {
118: throw new NullPointerException();
119: }
120: return UnmodifiableShortList.wrap(list);
121: }
122:
123: /**
124: * Returns an unmodifiable version of the given non-null ShortIterator.
125: * @param iter the non-null ShortIterator to wrap in an unmodifiable decorator
126: * @return an unmodifiable version of the given non-null ShortIterator
127: * @throws NullPoShorterException if the given ShortIterator is null
128: * @see org.apache.commons.collections.primitives.decorators.UnmodifiableShortIterator#wrap
129: */
130: public static ShortIterator unmodifiableShortIterator(
131: ShortIterator iter) {
132: if (null == iter) {
133: throw new NullPointerException();
134: }
135: return UnmodifiableShortIterator.wrap(iter);
136: }
137:
138: /**
139: * Returns an unmodifiable version of the given non-null ShortListIterator.
140: * @param iter the non-null ShortListIterator to wrap in an unmodifiable decorator
141: * @return an unmodifiable version of the given non-null ShortListIterator
142: * @throws NullPoShorterException if the given ShortListIterator is null
143: * @see org.apache.commons.collections.primitives.decorators.UnmodifiableShortListIterator#wrap
144: */
145: public static ShortListIterator unmodifiableShortListIterator(
146: ShortListIterator iter) {
147: if (null == iter) {
148: throw new NullPointerException();
149: }
150: return UnmodifiableShortListIterator.wrap(iter);
151: }
152:
153: /**
154: * Returns an unmodifiable, empty ShortList.
155: * @return an unmodifiable, empty ShortList.
156: * @see #EMPTY_SHORT_LIST
157: */
158: public static ShortList getEmptyShortList() {
159: return EMPTY_SHORT_LIST;
160: }
161:
162: /**
163: * Returns an unmodifiable, empty ShortIterator
164: * @return an unmodifiable, empty ShortIterator.
165: * @see #EMPTY_SHORT_ITERATOR
166: */
167: public static ShortIterator getEmptyShortIterator() {
168: return EMPTY_SHORT_ITERATOR;
169: }
170:
171: /**
172: * Returns an unmodifiable, empty ShortListIterator
173: * @return an unmodifiable, empty ShortListIterator.
174: * @see #EMPTY_SHORT_LIST_ITERATOR
175: */
176: public static ShortListIterator getEmptyShortListIterator() {
177: return EMPTY_SHORT_LIST_ITERATOR;
178: }
179:
180: /**
181: * An unmodifiable, empty ShortList
182: * @see #getEmptyShortList
183: */
184: public static final ShortList EMPTY_SHORT_LIST = unmodifiableShortList(new ArrayShortList(
185: 0));
186:
187: /**
188: * An unmodifiable, empty ShortIterator
189: * @see #getEmptyShortIterator
190: */
191: public static final ShortIterator EMPTY_SHORT_ITERATOR = unmodifiableShortIterator(EMPTY_SHORT_LIST
192: .iterator());
193:
194: /**
195: * An unmodifiable, empty ShortListIterator
196: * @see #getEmptyShortListIterator
197: */
198: public static final ShortListIterator EMPTY_SHORT_LIST_ITERATOR = unmodifiableShortListIterator(EMPTY_SHORT_LIST
199: .listIterator());
200: }
|