Vector源码注释

package java.util;


public class Vector<E> extends AbstractList<E>
    implements List<E>, RandomAccess, Cloneable, java.io.Serializable
{
    //保存数据的数组
    protected Object[] elementData;

    //实际数据的数量
    protected int elementCount;

    //容量增长系数
    protected int capacityIncrement;

    //序列版本号
    private static final long serialVersionUID = -2767605614048989439L;

    //指定容量大小和系数的构造方法
    public Vector(int initialCapacity, int capacityIncrement) {
				super();
				//容量小于零,抛出异常
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+initialCapacity);
				this.elementData = new Object[initialCapacity];
				this.capacityIncrement = capacityIncrement;
    }

    //指定容量的构造方法
    public Vector(int initialCapacity) {
			this(initialCapacity, 0);
    }

   
   	//无参构造方法 默认容量10
    public Vector() {
				this(10);
    }

    //指定集合的构造函数
    public Vector(Collection<? extends E> c) {
				elementData = c.toArray();
				elementCount = elementData.length;
				// c.toArray might (incorrectly) not return Object[] (see 6260652)
				if (elementData.getClass() != Object[].class)
				    elementData = Arrays.copyOf(elementData, elementCount, Object[].class);
    }

    //将数组Vector的全部元素拷贝到数组anArra中
    public synchronized void copyInto(Object[] anArray) {
	   		System.arraycopy(elementData, 0, anArray, 0, elementCount);
    }

    //将当前的容量值设置实际元素个数
    public synchronized void trimToSize() {
			modCount++;
			int oldCapacity = elementData.length;
			if (elementCount < oldCapacity) {
		            elementData = Arrays.copyOf(elementData, elementCount);
			}
    }

    //确定Vector的容量(设置最小容量)
    public synchronized void ensureCapacity(int minCapacity) {
    	//改变数加1
			modCount++;
			ensureCapacityHelper(minCapacity);
    }
 
    // 确认“Vector容量”的帮助函数
    private void ensureCapacityHelper(int minCapacity) {
			int oldCapacity = elementData.length;
			//设置的最小容量大于当前容量,扩容
			if (minCapacity > oldCapacity) {
			    Object[] oldData = elementData;
			    //当扩容系数大于0时,容量增大capacityIncrement个
			    //否则,容量扩大一倍
			    int newCapacity = (capacityIncrement > 0) ?
			    (oldCapacity + capacityIncrement) : (oldCapacity * 2);
			    		//如果扩容后的新容量还是小于最小容量,直接用最小容量
		    	    if (newCapacity < minCapacity) {
								newCapacity = minCapacity;
			    }
			    			//数组复制
		            elementData = Arrays.copyOf(elementData, newCapacity);
			}
    }

    //设置新容量
    public synchronized void setSize(int newSize) {
			modCount++;
			if (newSize > elementCount) {
					// 若 "newSize 大于 Vector容量",则调整Vector的大小。
			    ensureCapacityHelper(newSize);
			} else {
					// 若 "newSize 小于/等于 Vector容量",则将newSize位置开始的元素都设置为null
			    for (int i = newSize ; i < elementCount ; i++) {
						elementData[i] = null;
			    }
			}
			elementCount = newSize;
    }

    //返回“Vector的总容量”
    public synchronized int capacity() {
			return elementData.length;
    }

    //返回“Vector的实际大小”,即Vector中元素个数
    public synchronized int size() {
			return elementCount;
    }

    //判断vector是否为空
    public synchronized boolean isEmpty() {
			return elementCount == 0;
    }

    //返回“vector中全部元素对应的Enumeration”
    public Enumeration<E> elements() {
    	//使用匿名类实现Enumeration
			return new Enumeration<E>() {
	    	int count = 0;
				
				//是否存在下一个元素
	    	public boolean hasMoreElements() {
					return count < elementCount;
	    	}
				
				//获取下一个元素
	    	public E nextElement() {
					synchronized (Vector.this) {
			    	if (count < elementCount) {
							return (E)elementData[count++];
			    	}
					}
					throw new NoSuchElementException("Vector Enumeration");
	    }
	};
    }

    // 返回Vector中是否包含对象(o)
    public boolean contains(Object o) {
			return indexOf(o, 0) >= 0;
    }

    // 查找并返回元素(o)在Vector中的索引值
    public int indexOf(Object o) {
			return indexOf(o, 0);
    }

    //从index位置开始向后查找元素(o)
    //若找到,则返回元素的索引值;否则,返回-1
    public synchronized int indexOf(Object o, int index) {
			if (o == null) {
					//若查找元素为null,则整箱找出null元素,并返回他对应的序号
			    for (int i = index ; i < elementCount ; i++)
						if (elementData[i]==null)
				    return i;
			} else {
					// 若查找元素不为null,则正向找出该元素,并返回他对应的序号
			    for (int i = index ; i < elementCount ; i++)
						if (o.equals(elementData[i]))
				    return i;
			}
			return -1;
    }

    // 从后向前查找元素(o),并返回元素的索引
    public synchronized int lastIndexOf(Object o) {
			return lastIndexOf(o, elementCount-1);
    }

    //从后向前查找元素(o)。开始位置是前向后的第index个元素
    public synchronized int lastIndexOf(Object o, int index) {
        if (index >= elementCount)
            throw new IndexOutOfBoundsException(index + " >= "+ elementCount);

				if (o == null) {
						// 若查找元素为null,则反向查找出null元素,并返回它对应的序号
				    for (int i = index; i >= 0; i--)
							if (elementData[i]==null)
					    return i;
				} else {
						// 若查找元素不为null,则反向查找出该元素,并返回它对应的序号
				    for (int i = index; i >= 0; i--)
							if (o.equals(elementData[i]))
					    return i;
				}
				return -1;
    }

    //返回vector中index位置的元素
    //若index越界,则抛出异常
    public synchronized E elementAt(int index) {
				if (index >= elementCount) {
				    throw new ArrayIndexOutOfBoundsException(index + " >= " + elementCount);
				}

        return (E)elementData[index];
    }

    //获取vector的第一个元素
    public synchronized E firstElement() {
    	//若没有元素,则抛出异常
			if (elementCount == 0) {
			    throw new NoSuchElementException();
			}
			return (E)elementData[0];
    }

    //获取vector中的最后一个元素
    public synchronized E lastElement() {
    	//若没有元素,则抛出异常
			if (elementCount == 0) {
			    throw new NoSuchElementException();
			}
			return (E)elementData[elementCount - 1];
    }

    //设置index位置的元素为obj
    public synchronized void setElementAt(E obj, int index) {
    	//若索引越界,抛出异常
			if (index >= elementCount) {
			    throw new ArrayIndexOutOfBoundsException(index + " >= " +
								     elementCount);
			}
			elementData[index] = obj;
    }

    //删除index位置的元素
    public synchronized void removeElementAt(int index) {
    	//修改次数+1
			modCount++;
			//若索引越界,抛出异常
			if (index >= elementCount) {
			    throw new ArrayIndexOutOfBoundsException(index + " >= " +
								     elementCount);
			}
			else if (index < 0) {
			    throw new ArrayIndexOutOfBoundsException(index);
			}
			
			//要移动元素的个数
			int j = elementCount - index - 1;
			//将索引index开始的j个元素移动到 索引index+1开始的位置
			if (j > 0) {
			    System.arraycopy(elementData, index + 1, elementData, index, j);
			}
			//元素总数-1
			elementCount--;
			//最后一个元素设置为null
			elementData[elementCount] = null; /* to let gc do its work */
    }

    //在index位置处插入元素(obj)
    public synchronized void insertElementAt(E obj, int index) {
    	//修改次数+1
			modCount++;
			//若index越界,抛出异常
			if (index > elementCount) {
			    throw new ArrayIndexOutOfBoundsException(index
								     + " > " + elementCount);
			}
			//处理是否扩容问题
			ensureCapacityHelper(elementCount + 1);
			//移动元素
			System.arraycopy(elementData, index, elementData, index + 1, elementCount - index);
			//设置index位置元素为obj
			elementData[index] = obj;
			//元素总数+1
			elementCount++;
    }

    //添加元素obj到vector末尾
    public synchronized void addElement(E obj) {
    	//修改次数加+1
			modCount++;
			//处理是否需要扩容
			ensureCapacityHelper(elementCount + 1);
			//将末尾元素设置为obj
			elementData[elementCount++] = obj;
    }

    // 在Vector中查找并删除元素obj。
    // 成功的话,返回true;否则,返回false。
    public synchronized boolean removeElement(Object obj) {
    	//修改次数+1
			modCount++;
			//获取删除元素的索引
			int i = indexOf(obj);
			if (i >= 0) {
					//根据索引删除元素
			    removeElementAt(i);
			    return true;
			}
			return false;
    }

    //删除vector中的全部元素
    public synchronized void removeAllElements() {
    	  //修改次数加1
        modCount++;
				// Let gc do its work
				// 全部引用设置为空
				for (int i = 0; i < elementCount; i++)
				    elementData[i] = null;
			  //元素总个数设置为0
				elementCount = 0;
    }

    // 克隆函数
    public synchronized Object clone() {
			try {
			    Vector<E> v = (Vector<E>) super.clone();
			    // 将当前的Vector的全部元素拷贝到v中
			    v.elementData = Arrays.copyOf(elementData, elementCount);
			    v.modCount = 0;
			    return v;
			} catch (CloneNotSupportedException e) {
			    // this shouldn't happen, since we are Cloneable
			    throw new InternalError();
			}
    }

    //返回vector的object数组
    public synchronized Object[] toArray() {
        return Arrays.copyOf(elementData, elementCount);
    }

    // 返回Vector的泛型数组。所谓泛型数组,即可以将T设为任意的数据类型
    public synchronized <T> T[] toArray(T[] a) {
    	  //若数组a的大小 < vector的元素个数
    	  //则新建一个T[]数组,长度为Vector的元素个数,
    	  //并将vector全部元素拷贝到数组a中
        if (a.length < elementCount)
            return (T[]) Arrays.copyOf(elementData, elementCount, a.getClass());
				
				//若数组a的大小 >= Vector的元素个数
				//则将Vector的全部元素都拷贝到数组a中
				System.arraycopy(elementData, 0, a, 0, elementCount);
				//填不满的位置设置为null
        if (a.length > elementCount)
            a[elementCount] = null;

        return a;
    }

    // 位置方位操作
    
    // 获取index位置的元素
    public synchronized E get(int index) {
			if (index >= elementCount)
			    throw new ArrayIndexOutOfBoundsException(index);
		
			return (E)elementData[index];
    }

    // 设置index位置的值为element,并返回index位置的原始值
    public synchronized E set(int index, E element) {
			if (index >= elementCount)
			    throw new ArrayIndexOutOfBoundsException(index);
		
			Object oldValue = elementData[index];
			elementData[index] = element;
			return (E)oldValue;
    }

    // 将元素e添加到vector最后
    public synchronized boolean add(E e) {
				modCount++;
				ensureCapacityHelper(elementCount + 1);
				elementData[elementCount++] = e;
        return true;
    }

    //删除vector中的元素o
    public boolean remove(Object o) {
        return removeElement(o);
    }

    //在index位置添加元素element
    public void add(int index, E element) {
        insertElementAt(element, index);
    }

   
    // 删除index位置的元素,并返回index位置的原始值
    public synchronized E remove(int index) {
    	//修改次数+1
			modCount++;
			//索引越界,则抛出异常
			if (index >= elementCount)
			    throw new ArrayIndexOutOfBoundsException(index);
			Object oldValue = elementData[index];
			
			//要移动数据的个数
			int numMoved = elementCount - index - 1;
			//数组复制
			if (numMoved > 0)
			    System.arraycopy(elementData, index+1, elementData, index,
					     numMoved);
			//数组末尾设置为空
			elementData[--elementCount] = null; // Let gc do its work
			//返回旧数据
			return (E)oldValue;
    }

    //清空vector
    public void clear() {
        removeAllElements();
    }

    // 批量操作

    //返回Vector是否包含集合c
    public synchronized boolean containsAll(Collection<?> c) {
        return super.containsAll(c);
    }

    
    //将集合c添加到vector中
    public synchronized boolean addAll(Collection<? extends E> c) {
    		//修改次数+1
				modCount++;
				//获取集合数组
        Object[] a = c.toArray();
        //集合元素个数
        int numNew = a.length;
        //处理vector扩容问题
				ensureCapacityHelper(elementCount + numNew);
				//数组复制
        System.arraycopy(a, 0, elementData, elementCount, numNew);
        //设置vector元素总数
        elementCount += numNew;
				return numNew != 0;
    }

    // 删除集合c的全部元素
    public synchronized boolean removeAll(Collection<?> c) {
        return super.removeAll(c);
    }

    // 删除“非集合c中的元素”
    public synchronized boolean retainAll(Collection<?> c)  {
        return super.retainAll(c);
    }

    //  从index位置开始,将集合c添加到Vector中
    public synchronized boolean addAll(int index, Collection<? extends E> c) {
    	//更新修改次数
			modCount++;
			//如果数据越界,则抛出异常
			if (index < 0 || index > elementCount)
			    throw new ArrayIndexOutOfBoundsException(index);
			//获取集合c数组
		  Object[] a = c.toArray();
		  //集合c元素个数
			int numNew = a.length;
			//处理vector扩容问题
			ensureCapacityHelper(elementCount + numNew);
		  
		  //要移动的元素个数
			int numMoved = elementCount - index;
			//移动元素
			if (numMoved > 0)
			    System.arraycopy(elementData, index, elementData, index + numNew,
					     numMoved);
		  //添加集合c中的元素
		  System.arraycopy(a, 0, elementData, index, numNew);
		  //更新元素总数
			elementCount += numNew;
			return numNew != 0;
    }

    // 返回两个对象是否相等
    public synchronized boolean equals(Object o) {
        return super.equals(o);
    }

    // 计算哈希值
    public synchronized int hashCode() {
        return super.hashCode();
    }

    //调用父类的toString()
    public synchronized String toString() {
        return super.toString();
    }

    //获取Vector中的fromIndex(包括)到toIndex(不包括)的子集
    public synchronized List<E> subList(int fromIndex, int toIndex) {
        return Collections.synchronizedList(super.subList(fromIndex, toIndex),
                                            this);
    }

    // 删除Vector中fromIndex到toIndex的元素
    protected synchronized void removeRange(int fromIndex, int toIndex) {
    	  //更新修改次数
				modCount++;
				//要移动的元素个数
				int numMoved = elementCount - toIndex;
				//移动元素
			  System.arraycopy(elementData, toIndex, elementData, fromIndex,
			                         numMoved);
			
				// Let gc do its work
				//新元素总数
				int newElementCount = elementCount - (toIndex-fromIndex);
				//如果旧元素总数不等于新元素总数
				//则索引对应的位置设置为null
				while (elementCount != newElementCount)
				    elementData[--elementCount] = null;
    }

    // java.io.Serializable的写入函数
    private synchronized void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException
    {
				s.defaultWriteObject();
    }
}



转载于:https://my.oschina.net/u/140462/blog/198165

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值