1324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/* 2324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * [The "BSD license"] 3324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Copyright (c) 2010 Terence Parr 4324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * All rights reserved. 5324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 6324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Redistribution and use in source and binary forms, with or without 7324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * modification, are permitted provided that the following conditions 8324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * are met: 9324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 1. Redistributions of source code must retain the above copyright 10324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer. 11324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 2. Redistributions in binary form must reproduce the above copyright 12324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * notice, this list of conditions and the following disclaimer in the 13324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * documentation and/or other materials provided with the distribution. 14324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 3. The name of the author may not be used to endorse or promote products 15324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * derived from this software without specific prior written permission. 16324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * 17324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 28324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpackage org.antlr.misc; 29324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 30324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.ArrayList; 31324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.Iterator; 32324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.LinkedHashSet; 33324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverimport java.util.List; 34324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 35324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver/** A HashMap that remembers the order that the elements were added. 36324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * You can alter the ith element with set(i,value) too :) Unique list. 37324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * I need the replace/set-element-i functionality so I'm subclassing 38324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * OrderedHashSet. 39324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 40324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruverpublic class OrderedHashSet<T> extends LinkedHashSet { 41324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Track the elements as they are added to the set */ 42324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver protected List<T> elements = new ArrayList<T>(); 43324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 44324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public T get(int i) { 45324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return elements.get(i); 46324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 47324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 48324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Replace an existing value with a new value; updates the element 49324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * list and the hash table, but not the key as that has not changed. 50324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 51324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public T set(int i, T value) { 52324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver T oldElement = elements.get(i); 53324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver elements.set(i,value); // update list 54324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super.remove(oldElement); // now update the set: remove/add 55324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super.add(value); 56324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return oldElement; 57324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 58324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 59324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Add a value to list; keep in hashtable for consistency also; 60324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * Key is object itself. Good for say asking if a certain string is in 61324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * a list of strings. 62324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 63324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public boolean add(Object value) { 64324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver boolean result = super.add(value); 65324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( result ) { // only track if new element not in set 66324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver elements.add((T)value); 67324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 68324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return result; 69324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 70324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 71324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public boolean remove(Object o) { 72324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver throw new UnsupportedOperationException(); 73324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /* 74324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver elements.remove(o); 75324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return super.remove(o); 76324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 77324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 78324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 79324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public void clear() { 80324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver elements.clear(); 81324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver super.clear(); 82324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 83324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 84324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /** Return the List holding list of table elements. Note that you are 85324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver * NOT getting a copy so don't write to the list. 86324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 87324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public List<T> elements() { 88324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return elements; 89324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 90324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 91324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Iterator<T> iterator() { 92324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return elements.iterator(); 93324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 94324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 95324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public Object[] toArray() { 96324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return elements.toArray(); 97324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 98324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 99324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public int size() { 100324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver /* 101324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver if ( elements.size()!=super.size() ) { 102324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver ErrorManager.internalError("OrderedHashSet: elements and set size differs; "+ 103324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver elements.size()+"!="+super.size()); 104324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 105324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver */ 106324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return elements.size(); 107324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 108324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver 109324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver public String toString() { 110324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver return elements.toString(); 111324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver } 112324c4644fee44b9898524c09511bd33c3f12e2dfBen Gruver} 113