Update file layout for consistency

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131525 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2004-01-05 22:15:15 +00:00
parent d25ba06165
commit 797b45682f
15 changed files with 72 additions and 77 deletions

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractMapDecorator.java,v 1.1 2003/11/16 00:05:45 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractMapDecorator.java,v 1.2 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -75,13 +75,13 @@ import java.util.Set;
* But, you might want that loophole, so this class is kept simple.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:45 $
* @version $Revision: 1.2 $ $Date: 2004/01/05 22:15:14 $
*
* @author Daniel Rall
* @author Stephen Colebourne
*/
public abstract class AbstractMapDecorator implements Map {
/** The map to decorate */
protected final Map map;

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractOrderedMapDecorator.java,v 1.3 2003/12/01 22:48:59 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractOrderedMapDecorator.java,v 1.4 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -74,12 +74,13 @@ import org.apache.commons.collections.OrderedMapIterator;
* But, you might want that loophole, so this class is kept simple.
*
* @since Commons Collections 3.0
* @version $Revision: 1.3 $ $Date: 2003/12/01 22:48:59 $
* @version $Revision: 1.4 $ $Date: 2004/01/05 22:15:14 $
*
* @author Stephen Colebourne
*/
public abstract class AbstractOrderedMapDecorator extends AbstractMapDecorator implements OrderedMap {
public abstract class AbstractOrderedMapDecorator
extends AbstractMapDecorator implements OrderedMap {
/**
* Constructor that wraps (not copies).
*

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractSortedMapDecorator.java,v 1.1 2003/11/16 00:05:45 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractSortedMapDecorator.java,v 1.2 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -73,12 +73,13 @@ import java.util.SortedMap;
* But, you might want that loophole, so this class is kept simple.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:45 $
* @version $Revision: 1.2 $ $Date: 2004/01/05 22:15:14 $
*
* @author Stephen Colebourne
*/
public abstract class AbstractSortedMapDecorator extends AbstractMapDecorator implements SortedMap {
public abstract class AbstractSortedMapDecorator
extends AbstractMapDecorator implements SortedMap {
/**
* Constructor that wraps (not copies).
*

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/PredicatedMap.java,v 1.4 2003/12/29 15:08:15 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/PredicatedMap.java,v 1.5 2004/01/05 22:15:15 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -75,7 +75,7 @@ import org.apache.commons.collections.keyvalue.AbstractMapEntryDecorator;
* is thrown.
*
* @since Commons Collections 3.0
* @version $Revision: 1.4 $ $Date: 2003/12/29 15:08:15 $
* @version $Revision: 1.5 $ $Date: 2004/01/05 22:15:15 $
*
* @author Stephen Colebourne
* @author Paul Jack
@ -101,7 +101,7 @@ public class PredicatedMap extends AbstractMapDecorator {
public static Map decorate(Map map, Predicate keyPredicate, Predicate valuePredicate) {
return new PredicatedMap(map, keyPredicate, valuePredicate);
}
//-----------------------------------------------------------------------
/**
* Constructor that wraps (not copies).

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/PredicatedSortedMap.java,v 1.1 2003/11/16 00:05:45 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/PredicatedSortedMap.java,v 1.2 2004/01/05 22:15:15 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -70,12 +70,13 @@ import org.apache.commons.collections.Predicate;
* is thrown.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:45 $
* @version $Revision: 1.2 $ $Date: 2004/01/05 22:15:15 $
*
* @author Stephen Colebourne
* @author Paul Jack
*/
public class PredicatedSortedMap extends PredicatedMap implements SortedMap {
public class PredicatedSortedMap
extends PredicatedMap implements SortedMap {
/**
* Factory method to create a predicated (validating) sorted map.

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/ReferenceMap.java,v 1.6 2003/12/29 15:08:15 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/ReferenceMap.java,v 1.7 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 The Apache Software Foundation. All rights
* Copyright (c) 2002-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -119,7 +119,7 @@ import org.apache.commons.collections.keyvalue.DefaultMapEntry;
* @see java.lang.ref.Reference
*
* @since Commons Collections 3.0 (previously in main package v2.1)
* @version $Revision: 1.6 $ $Date: 2003/12/29 15:08:15 $
* @version $Revision: 1.7 $ $Date: 2004/01/05 22:15:14 $
*
* @author Paul Jack
*/
@ -130,28 +130,23 @@ public class ReferenceMap extends AbstractMap {
*/
private static final long serialVersionUID = -3370601314380922368L;
/**
* Constant indicating that hard references should be used.
*/
public static final int HARD = 0;
/**
* Constant indicating that soft references should be used.
*/
public static final int SOFT = 1;
/**
* Constant indicating that weak references should be used.
*/
public static final int WEAK = 2;
// --- serialized instance variables:
/**
* The reference type for keys. Must be HARD, SOFT, WEAK.
* Note: I originally marked this field as final, but then this class
@ -160,7 +155,6 @@ public class ReferenceMap extends AbstractMap {
*/
private int keyType;
/**
* The reference type for values. Must be HARD, SOFT, WEAK.
* Note: I originally marked this field as final, but then this class
@ -169,7 +163,6 @@ public class ReferenceMap extends AbstractMap {
*/
private int valueType;
/**
* The threshold variable is calculated by multiplying
* table.length and loadFactor.
@ -184,7 +177,6 @@ public class ReferenceMap extends AbstractMap {
*/
private boolean purgeValues = false;
// -- Non-serialized instance variables
/**
@ -193,50 +185,42 @@ public class ReferenceMap extends AbstractMap {
*/
private transient ReferenceQueue queue = new ReferenceQueue();
/**
* The hash table. Its length is always a power of two.
*/
private transient Entry[] table;
/**
* Number of mappings in this map.
*/
private transient int size;
/**
* When size reaches threshold, the map is resized.
* See resize().
*/
private transient int threshold;
/**
* Number of times this map has been modified.
*/
private transient volatile int modCount;
/**
* Cached key set. May be null if key set is never accessed.
*/
private transient Set keySet;
/**
* Cached entry set. May be null if entry set is never accessed.
*/
private transient Set entrySet;
/**
* Cached values. May be null if values() is never accessed.
*/
private transient Collection values;
/**
* Constructs a new <code>ReferenceMap</code> that will
* use hard references to keys and soft references to values.

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/StaticBucketMap.java,v 1.7 2004/01/02 02:13:07 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/StaticBucketMap.java,v 1.8 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
* Copyright (c) 2002-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -132,7 +132,7 @@ import org.apache.commons.collections.KeyValue;
* operations will affect the map.<p>
*
* @since Commons Collections 3.0 (previously in main package v2.1)
* @version $Revision: 1.7 $ $Date: 2004/01/02 02:13:07 $
* @version $Revision: 1.8 $ $Date: 2004/01/05 22:15:14 $
*
* @author Berin Loritsch
* @author Gerhard Froehlich
@ -143,8 +143,11 @@ import org.apache.commons.collections.KeyValue;
*/
public final class StaticBucketMap implements Map {
/** The default number of buckets to use */
private static final int DEFAULT_BUCKETS = 255;
/** The array of buckets, where the actual data is held */
private Node[] buckets;
/** The matching array of locks */
private Lock[] locks;
/**

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TransformedMap.java,v 1.3 2003/12/25 00:49:14 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TransformedMap.java,v 1.4 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -77,7 +77,7 @@ import org.apache.commons.collections.keyvalue.AbstractMapEntryDecorator;
* use the Integer form to remove objects.
*
* @since Commons Collections 3.0
* @version $Revision: 1.3 $ $Date: 2003/12/25 00:49:14 $
* @version $Revision: 1.4 $ $Date: 2004/01/05 22:15:14 $
*
* @author Stephen Colebourne
*/
@ -102,7 +102,7 @@ public class TransformedMap extends AbstractMapDecorator {
public static Map decorate(Map map, Transformer keyTransformer, Transformer valueTransformer) {
return new TransformedMap(map, keyTransformer, valueTransformer);
}
//-----------------------------------------------------------------------
/**
* Constructor that wraps (not copies).

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TransformedSortedMap.java,v 1.1 2003/11/16 00:05:45 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TransformedSortedMap.java,v 1.2 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -71,11 +71,12 @@ import org.apache.commons.collections.Transformer;
* use the Integer form to remove objects.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:45 $
* @version $Revision: 1.2 $ $Date: 2004/01/05 22:15:14 $
*
* @author Stephen Colebourne
*/
public class TransformedSortedMap extends TransformedMap implements SortedMap {
public class TransformedSortedMap
extends TransformedMap implements SortedMap {
/**
* Factory method to create a transforming sorted map.

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TypedMap.java,v 1.1 2003/11/16 00:05:45 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TypedMap.java,v 1.2 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -70,7 +70,7 @@ import org.apache.commons.collections.PredicateUtils;
* collection, an IllegalArgumentException is thrown.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:45 $
* @version $Revision: 1.2 $ $Date: 2004/01/05 22:15:14 $
*
* @author Stephen Colebourne
* @author Matthew Hawthorne
@ -96,7 +96,7 @@ public class TypedMap {
PredicateUtils.instanceofPredicate(valueType)
);
}
/**
* Restrictive constructor.
*/

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TypedSortedMap.java,v 1.1 2003/11/16 00:05:45 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/TypedSortedMap.java,v 1.2 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -70,7 +70,7 @@ import org.apache.commons.collections.PredicateUtils;
* collection, an IllegalArgumentException is thrown.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:45 $
* @version $Revision: 1.2 $ $Date: 2004/01/05 22:15:14 $
*
* @author Stephen Colebourne
* @author Matthew Hawthorne
@ -96,7 +96,7 @@ public class TypedSortedMap {
PredicateUtils.instanceofPredicate(valueType)
);
}
/**
* Restrictive constructor.
*/

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java,v 1.3 2003/12/29 15:08:15 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableEntrySet.java,v 1.4 2004/01/05 22:15:14 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -72,12 +72,13 @@ import org.apache.commons.collections.set.AbstractSetDecorator;
* Decorates a map entry <code>Set</code> to ensure it can't be altered.
*
* @since Commons Collections 3.0
* @version $Revision: 1.3 $ $Date: 2003/12/29 15:08:15 $
* @version $Revision: 1.4 $ $Date: 2004/01/05 22:15:14 $
*
* @author Stephen Colebourne
*/
public final class UnmodifiableEntrySet extends AbstractSetDecorator implements Unmodifiable {
public final class UnmodifiableEntrySet
extends AbstractSetDecorator implements Unmodifiable {
/**
* Factory method to create an unmodifiable set of Map Entry objects.
*

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableMap.java,v 1.6 2003/12/03 12:27:36 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableMap.java,v 1.7 2004/01/05 22:15:15 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -73,11 +73,12 @@ import org.apache.commons.collections.set.UnmodifiableSet;
* Decorates another <code>Map</code> to ensure it can't be altered.
*
* @since Commons Collections 3.0
* @version $Revision: 1.6 $ $Date: 2003/12/03 12:27:36 $
* @version $Revision: 1.7 $ $Date: 2004/01/05 22:15:15 $
*
* @author Stephen Colebourne
*/
public final class UnmodifiableMap extends AbstractMapDecorator implements IterableMap, Unmodifiable {
public final class UnmodifiableMap
extends AbstractMapDecorator implements IterableMap, Unmodifiable {
/**
* Factory method to create an unmodifiable map.

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java,v 1.4 2003/12/03 12:27:36 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableOrderedMap.java,v 1.5 2004/01/05 22:15:15 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -74,11 +74,12 @@ import org.apache.commons.collections.set.UnmodifiableSet;
* Decorates another <code>OrderedMap</code> to ensure it can't be altered.
*
* @since Commons Collections 3.0
* @version $Revision: 1.4 $ $Date: 2003/12/03 12:27:36 $
* @version $Revision: 1.5 $ $Date: 2004/01/05 22:15:15 $
*
* @author Stephen Colebourne
*/
public final class UnmodifiableOrderedMap extends AbstractOrderedMapDecorator implements Unmodifiable {
public final class UnmodifiableOrderedMap
extends AbstractOrderedMapDecorator implements Unmodifiable {
/**
* Factory method to create an unmodifiable sorted map.

View File

@ -1,10 +1,10 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java,v 1.3 2003/12/03 12:27:36 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/UnmodifiableSortedMap.java,v 1.4 2004/01/05 22:15:15 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* Copyright (c) 2003-2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
@ -71,11 +71,12 @@ import org.apache.commons.collections.set.UnmodifiableSet;
* Decorates another <code>SortedMap</code> to ensure it can't be altered.
*
* @since Commons Collections 3.0
* @version $Revision: 1.3 $ $Date: 2003/12/03 12:27:36 $
* @version $Revision: 1.4 $ $Date: 2004/01/05 22:15:15 $
*
* @author Stephen Colebourne
*/
public final class UnmodifiableSortedMap extends AbstractSortedMapDecorator implements Unmodifiable {
public final class UnmodifiableSortedMap
extends AbstractSortedMapDecorator implements Unmodifiable {
/**
* Factory method to create an unmodifiable sorted map.