Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Dec 14, 2023
1 parent ae72194 commit 8e0bc67
Show file tree
Hide file tree
Showing 26 changed files with 44 additions and 44 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ static class BagIterator<E> implements Iterator<E> {
private boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
*
* @param parent the parent bag
*/
Expand Down Expand Up @@ -406,7 +406,7 @@ protected static class MutableInteger {
protected int value;

/**
* Constructor.
* Constructs a new instance.
* @param value the initial value
*/
MutableInteger(final int value) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ final class SynchronizedBagSet extends SynchronizedCollection<E> implements Set<
private static final long serialVersionUID = 2990565892366827855L;

/**
* Constructor.
* Constructs a new instance.
* @param set the set to decorate
* @param lock the lock to use, shared with the bag
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ protected abstract static class View<K, V, E> extends AbstractCollectionDecorato
protected final AbstractDualBidiMap<K, V> parent;

/**
* Constructor.
* Constructs a new instance.
*
* @param coll the collection view being decorated
* @param parent the parent BidiMap
Expand Down Expand Up @@ -445,7 +445,7 @@ protected static class KeySet<K> extends View<K, Object, K> implements Set<K> {
private static final long serialVersionUID = -7107935777385040694L;

/**
* Constructor.
* Constructs a new instance.
*
* @param parent the parent BidiMap
*/
Expand Down Expand Up @@ -492,7 +492,7 @@ protected static class KeySetIterator<K> extends AbstractIteratorDecorator<K> {
protected boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
* @param iterator the iterator to decorate
* @param parent the parent map
*/
Expand Down Expand Up @@ -532,7 +532,7 @@ protected static class Values<V> extends View<Object, V, V> implements Set<V> {
private static final long serialVersionUID = 4023777119829639864L;

/**
* Constructor.
* Constructs a new instance.
*
* @param parent the parent BidiMap
*/
Expand Down Expand Up @@ -579,7 +579,7 @@ protected static class ValuesIterator<V> extends AbstractIteratorDecorator<V> {
protected boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
* @param iterator the iterator to decorate
* @param parent the parent map
*/
Expand Down Expand Up @@ -620,7 +620,7 @@ protected static class EntrySet<K, V> extends View<K, V, Map.Entry<K, V>> implem
private static final long serialVersionUID = 4040410962603292348L;

/**
* Constructor.
* Constructs a new instance.
*
* @param parent the parent BidiMap
*/
Expand Down Expand Up @@ -670,7 +670,7 @@ protected static class EntrySetIterator<K, V> extends AbstractIteratorDecorator<
protected boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
* @param iterator the iterator to decorate
* @param parent the parent map
*/
Expand Down Expand Up @@ -712,7 +712,7 @@ protected static class MapEntry<K, V> extends AbstractMapEntryDecorator<K, V> {
protected final AbstractDualBidiMap<K, V> parent;

/**
* Constructor.
* Constructs a new instance.
* @param entry the entry to decorate
* @param parent the parent map
*/
Expand Down Expand Up @@ -755,7 +755,7 @@ protected static class BidiMapIterator<K, V> implements MapIterator<K, V>, Reset
protected boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
* @param parent the parent map
*/
protected BidiMapIterator(final AbstractDualBidiMap<K, V> parent) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ public SortedBidiMap<V, K> inverseBidiMap() {
*/
protected static class ViewMap<K, V> extends AbstractSortedMapDecorator<K, V> {
/**
* Constructor.
* Constructs a new instance.
* @param bidi the parent bidi map
* @param sm the subMap sorted map
*/
Expand Down Expand Up @@ -310,7 +310,7 @@ protected static class BidiOrderedMapIterator<K, V> implements OrderedMapIterato
private Map.Entry<K, V> last;

/**
* Constructor.
* Constructs a new instance.
* @param parent the parent map
*/
protected BidiOrderedMapIterator(final AbstractDualBidiMap<K, V> parent) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1477,7 +1477,7 @@ abstract class AbstractView<E> extends AbstractSet<E> {
final DataElement orderType;

/**
* Constructor.
* Constructs a new instance.
* @param orderType the KEY or VALUE int for the order
*/
AbstractView(final DataElement orderType) {
Expand Down Expand Up @@ -1648,7 +1648,7 @@ abstract class AbstractViewIterator {
private int expectedModifications;

/**
* Constructor.
* Constructs a new instance.
* @param orderType the KEY or VALUE int for the order
*/
AbstractViewIterator(final DataElement orderType) {
Expand Down Expand Up @@ -1720,7 +1720,7 @@ public final void remove() {
final class ViewMapIterator extends AbstractViewIterator implements OrderedMapIterator<K, V> {

/**
* Constructor.
* Constructs a new instance.
*/
ViewMapIterator(final DataElement orderType) {
super(orderType);
Expand Down Expand Up @@ -1812,7 +1812,7 @@ public V previous() {
final class ViewMapEntryIterator extends AbstractViewIterator implements OrderedIterator<Map.Entry<K, V>> {

/**
* Constructor.
* Constructs a new instance.
*/
ViewMapEntryIterator() {
super(KEY);
Expand All @@ -1835,7 +1835,7 @@ public Map.Entry<K, V> previous() {
final class InverseViewMapEntryIterator extends AbstractViewIterator implements OrderedIterator<Map.Entry<V, K>> {

/**
* Constructor.
* Constructs a new instance.
*/
InverseViewMapEntryIterator() {
super(VALUE);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public static <T> Transformer<T, T> cloneTransformer() {
}

/**
* Constructor.
* Constructs a new instance.
*/
private CloneTransformer() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public static <E> Closure<E> nopClosure() {
}

/**
* Constructor.
* Constructs a new instance.
*/
private NOPClosure() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public static <T> Transformer<T, T> nopTransformer() {
}

/**
* Constructor.
* Constructs a new instance.
*/
private NOPTransformer() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
abstract class AbstractEmptyIterator<E> {

/**
* Constructor.
* Constructs a new instance.
*/
protected AbstractEmptyIterator() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public static <E> Iterator<E> emptyIterator() {
}

/**
* Constructor.
* Constructs a new instance.
*/
protected EmptyIterator() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public static <E> ListIterator<E> emptyListIterator() {
}

/**
* Constructor.
* Constructs a new instance.
*/
protected EmptyListIterator() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public static <K, V> MapIterator<K, V> emptyMapIterator() {
}

/**
* Constructor.
* Constructs a new instance.
*/
protected EmptyMapIterator() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public static <E> OrderedIterator<E> emptyOrderedIterator() {
}

/**
* Constructor.
* Constructs a new instance.
*/
protected EmptyOrderedIterator() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public static <K, V> OrderedMapIterator<K, V> emptyOrderedMapIterator() {
}

/**
* Constructor.
* Constructs a new instance.
*/
protected EmptyOrderedMapIterator() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public class EntrySetMapIterator<K, V> implements MapIterator<K, V>, ResettableI
private boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
*
* @param map the map to iterate over
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public static <E> PeekingIterator<E> peekingIterator(final Iterator<? extends E>
}

/**
* Constructor.
* Constructs a new instance.
*
* @param iterator the iterator to decorate
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static <E> PushbackIterator<E> pushbackIterator(final Iterator<? extends
}

/**
* Constructor.
* Constructs a new instance.
*
* @param iterator the iterator to decorate
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public static <E> Iterator<E> unmodifiableIterator(final Iterator<? extends E> i
}

/**
* Constructor.
* Constructs a new instance.
*
* @param iterator the iterator to decorate
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public static <E> ListIterator<E> umodifiableListIterator(final ListIterator<? e
}

/**
* Constructor.
* Constructs a new instance.
*
* @param iterator the iterator to decorate
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public static <K, V> MapIterator<K, V> unmodifiableMapIterator(
}

/**
* Constructor.
* Constructs a new instance.
*
* @param iterator the iterator to decorate
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public static <K, V> OrderedMapIterator<K, V> unmodifiableOrderedMapIterator(
}

/**
* Constructor.
* Constructs a new instance.
*
* @param iterator the iterator to decorate
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public class Flat3Map<K, V> implements IterableMap<K, V>, Serializable, Cloneabl
private transient AbstractHashedMap<K, V> delegateMap;

/**
* Constructor.
* Constructs a new instance.
*/
public Flat3Map() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ private static final class MapBasedMultiSetIterator<E> implements Iterator<E> {
private boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
*
* @param parent the parent multiset
*/
Expand Down Expand Up @@ -273,7 +273,7 @@ protected static class MutableInteger {
protected int value;

/**
* Constructor.
* Constructs a new instance.
* @param value the initial value
*/
MutableInteger(final int value) {
Expand Down Expand Up @@ -324,7 +324,7 @@ protected static class UniqueSetIterator<E> extends AbstractIteratorDecorator<E>
protected boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
* @param iterator the iterator to decorate
* @param parent the parent multiset
*/
Expand Down Expand Up @@ -370,7 +370,7 @@ protected static class EntrySetIterator<E> implements Iterator<Entry<E>> {
protected boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
* @param iterator the iterator to decorate
* @param parent the parent multiset
*/
Expand Down Expand Up @@ -411,7 +411,7 @@ protected static class MultiSetEntry<E> extends AbstractEntry<E> {
protected final Map.Entry<E, MutableInteger> parentEntry;

/**
* Constructor.
* Constructs a new instance.
* @param parentEntry the entry to decorate
*/
protected MultiSetEntry(final Map.Entry<E, MutableInteger> parentEntry) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ private static final class MultiSetIterator<E> implements Iterator<E> {
private boolean canRemove;

/**
* Constructor.
* Constructs a new instance.
*
* @param parent the parent multiset
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ static class SynchronizedSet<T> extends SynchronizedCollection<T> implements Set
private static final long serialVersionUID = 20150629L;

/**
* Constructor.
* Constructs a new instance.
* @param set the set to decorate
* @param lock the lock to use, shared with the multiset
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public abstract class AbstractSerializableSetDecorator<E>
private static final long serialVersionUID = 1229469966212206107L;

/**
* Constructor.
* Constructs a new instance.
*
* @param set the list to decorate, must not be null
* @throws NullPointerException if set is null
Expand Down

0 comments on commit 8e0bc67

Please sign in to comment.