/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.bind.util;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
/**
* {@link List} with modification detection capability.
*
* <p>
* This wrapper class exposes two additional methods
* <code>setModified</code> and <code>isModified</code>
* to check whether the contents of a list is modified.
*
* <p>
* I originally thought the modCount field of AbstractList
* is suffice to implement this capability, but a close look
* at the source code reveals that modCount is not updated
* when value is modified without a structural change.
* This includes modifying a value of a list, for example.
*
* <p>
* Thus unfortunately we need to trap the calls to all
* the mutation methods of List.
*
* <p>
* Note that Iterator implementation of AbstractList
* modifies list directly without using a public method
* of List. Thus we also need to wrap Iterators.
*
* @since JAXB1.0
* @author
* Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
*/
public abstract class ProxyListImpl<T> implements List<T>, java.io.Serializable {
final static long serialVersionUID=1L;
/** The actual storage. */
protected final List<T> core;
public ProxyListImpl() { this(new LinkedList<T>()); }
public ProxyListImpl(List<T> c) { core=c; }
public abstract void setModified( boolean f );
public void add(int index, T element) {
setModified(true);
core.add(index, element);
}
public boolean add(T o) {
setModified(true);
return core.add(o);
}
public boolean addAll(Collection<? extends T> c) {
setModified(true);
return core.addAll(c);
}
public boolean addAll(int index, Collection<? extends T> c) {
setModified(true);
return core.addAll(index, c);
}
public T set(int index, T element) {
setModified(true);
return core.set(index,element);
}
// public void addFirst(Object o) {
// isModified = true;
// core.addFirst(o);
// }
// public void addLast(Object o) {
// isModified = true;
// core.addLast(o);
// }
public void clear() {
setModified(true);
core.clear();
}
public T remove(int index) {
setModified(true);
return core.remove(index);
}
public boolean remove(Object o) {
setModified(true);
return core.remove(o);
}
// public Object removeFirst() {
// isModified = true;
// return core.removeFirst();
// }
// public Object removeLast() {
// isModified = true;
// return core.removeLast();
// }
public Iterator<T> iterator() {
setModified(true);
return new Itr<T>(core.iterator());
}
public ListIterator<T> listIterator(int index) {
setModified(true);
return new ListItr<T>(core.listIterator(index));
}
public ListIterator<T> listIterator() {
setModified(true);
return new ListItr<T>(core.listIterator());
}
public boolean removeAll(Collection<?> c) {
setModified(true);
return core.removeAll(c);
}
public boolean retainAll(Collection<?> c) {
setModified(true);
return core.retainAll(c);
}
/**
* Iterator wrapper
*/
class Itr<T> implements Iterator<T>
{
private Iterator<T> base;
Itr( Iterator<T> base ) { this.base=base; }
public boolean hasNext() {
return base.hasNext();
}
public T next() {
return base.next();
}
public void remove() {
base.remove();
setModified(true);
}
}
class ListItr<T> extends Itr<T> implements ListIterator<T>
{
private ListIterator<T> itr;
ListItr( ListIterator<T> base ) { super(base);this.itr=base; }
public void add(T o) {
}
public boolean hasPrevious() {
return itr.hasPrevious();
}
public int nextIndex() {
return itr.nextIndex();
}
public T previous() {
return itr.previous();
}
public int previousIndex() {
return itr.previousIndex();
}
public void set(T o) {
itr.set(o);
setModified(true);
}
}
// const methods
public boolean contains(Object o) {
return core.contains(o);
}
public boolean containsAll(Collection<?> c) {
return core.containsAll(c);
}
public T get(int index) {
return core.get(index);
}
public int indexOf(Object o) {
return core.indexOf(o);
}
public boolean isEmpty() {
return core.isEmpty();
}
public int lastIndexOf(Object o) {
return core.lastIndexOf(o);
}
public int size() {
return core.size();
}
public List<T> subList(int fromIndex, int toIndex) {
final ProxyListImpl externalThis = this;
return new ProxyListImpl<T>(core.subList(fromIndex,toIndex)) {
public void setModified(boolean f) {
externalThis.setModified(true);
}
};
}
public Object[] toArray() {
return core.toArray();
}
public <T> T[] toArray(T[] a) {
return core.toArray(a);
}
public boolean equals( Object o ) {
return core.equals(o);
}
public int hashCode() {
return core.hashCode();
}
}