Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Nov 11, 2023
1 parent c900429 commit 32c68b7
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public static <T> FluentIterable<T> of(final T... elements) {
}

/**
* Construct a new FluentIterable from the provided iterable. If the
* Constructs a new FluentIterable from the provided iterable. If the
* iterable is already an instance of FluentIterable, the instance
* will be returned instead.
* <p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public class ComparatorChain<E> implements Comparator<E>, Serializable {
private boolean isLocked;

/**
* Construct a ComparatorChain with no Comparators.
* Constructs a ComparatorChain with no Comparators.
* You must add at least one Comparator before calling
* the compare(Object,Object) method, or an
* UnsupportedOperationException is thrown
Expand All @@ -74,7 +74,7 @@ public ComparatorChain() {
}

/**
* Construct a ComparatorChain with a single Comparator,
* Constructs a ComparatorChain with a single Comparator,
* sorting in the forward order
*
* @param comparator First comparator in the Comparator chain
Expand All @@ -84,7 +84,7 @@ public ComparatorChain(final Comparator<E> comparator) {
}

/**
* Construct a Comparator chain with a single Comparator,
* Constructs a Comparator chain with a single Comparator,
* sorting in the given order
*
* @param comparator First Comparator in the ComparatorChain
Expand All @@ -100,7 +100,7 @@ public ComparatorChain(final Comparator<E> comparator, final boolean reverse) {
}

/**
* Construct a ComparatorChain from the Comparators in the
* Constructs a ComparatorChain from the Comparators in the
* List. All Comparators will default to the forward
* sort order.
*
Expand All @@ -112,7 +112,7 @@ public ComparatorChain(final List<Comparator<E>> list) {
}

/**
* Construct a ComparatorChain from the Comparators in the
* Constructs a ComparatorChain from the Comparators in the
* given List. The sort order of each column will be
* drawn from the given BitSet. When determining the sort
* order for Comparator at index <i>i</i> in the List,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public ArrayIterator(final Object array, final int startIndex) {
}

/**
* Construct an ArrayIterator that will iterate over a range of values
* Constructs an ArrayIterator that will iterate over a range of values
* in the specified array.
*
* @param array the array to iterate over.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public ArrayListIterator(final Object array, final int startIndex) {
}

/**
* Construct an ArrayListIterator that will iterate over a range of values
* Constructs an ArrayListIterator that will iterate over a range of values
* in the specified array.
*
* @param array the array to iterate over
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public class IteratorChain<E> implements Iterator<E> {
private boolean isLocked;

/**
* Construct an IteratorChain with no Iterators.
* Constructs an IteratorChain with no Iterators.
* <p>
* You will normally use {@link #addIterator(Iterator)} to add some
* iterators after using this constructor.
Expand All @@ -79,7 +79,7 @@ public IteratorChain() {
}

/**
* Construct an IteratorChain with a single Iterator.
* Constructs an IteratorChain with a single Iterator.
* <p>
* This method takes one iterator. The newly constructed iterator will
* iterate through that iterator. Thus calling this constructor on its own
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public ObjectArrayIterator(final E[] array, final int start) {
}

/**
* Construct an ObjectArrayIterator that will iterate over a range of values
* Constructs an ObjectArrayIterator that will iterate over a range of values
* in the specified array.
*
* @param array the array to iterate over
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public ObjectArrayListIterator(final E[] array, final int start) {
}

/**
* Construct an ObjectArrayListIterator that will iterate over a range of values
* Constructs an ObjectArrayListIterator that will iterate over a range of values
* in the specified array.
*
* @param array the array to iterate over
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ public ConstantTimeToLiveExpirationPolicy() {
}

/**
* Construct a policy with the given time-to-live constant measured in
* Constructs a policy with the given time-to-live constant measured in
* milliseconds. A negative time-to-live value indicates entries never
* expire. A zero time-to-live value indicates entries expire (nearly)
* immediately.
Expand All @@ -106,7 +106,7 @@ public ConstantTimeToLiveExpirationPolicy(final long timeToLiveMillis) {
}

/**
* Construct a policy with the given time-to-live constant measured in
* Constructs a policy with the given time-to-live constant measured in
* the given time unit of measure.
*
* @param timeToLive the constant amount of time an entry is available
Expand Down Expand Up @@ -210,7 +210,7 @@ public PassiveExpiringMap() {
}

/**
* Construct a map decorator using the given expiration policy to determine
* Constructs a map decorator using the given expiration policy to determine
* expiration times.
*
* @param expiringPolicy the policy used to determine expiration times of
Expand All @@ -222,7 +222,7 @@ public PassiveExpiringMap(final ExpirationPolicy<K, V> expiringPolicy) {
}

/**
* Construct a map decorator that decorates the given map and uses the given
* Constructs a map decorator that decorates the given map and uses the given
* expiration policy to determine expiration times. If there are any
* elements already in the map being decorated, they will NEVER expire
* unless they are replaced.
Expand All @@ -239,7 +239,7 @@ public PassiveExpiringMap(final ExpirationPolicy<K, V> expiringPolicy,
}

/**
* Construct a map decorator that decorates the given map using the given
* Constructs a map decorator that decorates the given map using the given
* time-to-live value measured in milliseconds to create and use a
* {@link ConstantTimeToLiveExpirationPolicy} expiration policy.
*
Expand All @@ -254,7 +254,7 @@ public PassiveExpiringMap(final long timeToLiveMillis) {
}

/**
* Construct a map decorator using the given time-to-live value measured in
* Constructs a map decorator using the given time-to-live value measured in
* milliseconds to create and use a
* {@link ConstantTimeToLiveExpirationPolicy} expiration policy. If there
* are any elements already in the map being decorated, they will NEVER
Expand All @@ -273,7 +273,7 @@ public PassiveExpiringMap(final long timeToLiveMillis, final Map<K, V> map) {
}

/**
* Construct a map decorator using the given time-to-live value measured in
* Constructs a map decorator using the given time-to-live value measured in
* the given time units of measure to create and use a
* {@link ConstantTimeToLiveExpirationPolicy} expiration policy.
*
Expand All @@ -289,7 +289,7 @@ public PassiveExpiringMap(final long timeToLive, final TimeUnit timeUnit) {
}

/**
* Construct a map decorator that decorates the given map using the given
* Constructs a map decorator that decorates the given map using the given
* time-to-live value measured in the given time units of measure to create
* {@link ConstantTimeToLiveExpirationPolicy} expiration policy. This policy
* is used to determine expiration times. If there are any elements already
Expand Down

0 comments on commit 32c68b7

Please sign in to comment.