Skip to content

Commit

Permalink
javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
tpietzsch committed May 7, 2024
1 parent 6d46513 commit 57160bc
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 49 deletions.
14 changes: 11 additions & 3 deletions src/main/java/net/imglib2/IterableRealInterval.java
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,17 @@ default T firstElement() // TODO: fix places where it is not necessary to implem
return iterator().next();
}

/*
* NB: We cannot have a default implementation here because of
* https://bugs.openjdk.org/browse/JDK-7120669
/**
* Get an instance of {@code T}.
* <p>
* It should not be assumed that the returned {@code T} instance is an
* independent copy. In particular, repeated calls to {@code getType()} may
* return the same instance.
* <p>
* The default implementation returns {@link #firstElement}. Derived classes
* may choose different implementations for improved performance.
*
* @return an instance of {@code T}
*/
@Override
default T getType()
Expand Down
13 changes: 2 additions & 11 deletions src/main/java/net/imglib2/RandomAccessible.java
Original file line number Diff line number Diff line change
Expand Up @@ -182,17 +182,8 @@ default T getAt( final Localizable position )
}

/*
* Get an instance of {@code T}.
* <p>
* It should not be assumed that the returned {@code T} instance is an
* independent copy. In particular, repeated calls to {@code getType()} may
* return the same instance.
* <p>
* The default implementation queries the value at the default coordinate of
* {@link RandomAccessible#randomAccess()}. Derived classes may choose
* different implementations for improved performance.
*
* @return an instance of {@code T}
* NB: We cannot have a default implementation here because of
* https://bugs.openjdk.org/browse/JDK-7120669
*/
// @Override
// default T getType()
Expand Down
13 changes: 2 additions & 11 deletions src/main/java/net/imglib2/RandomAccessibleInterval.java
Original file line number Diff line number Diff line change
Expand Up @@ -65,17 +65,8 @@
public interface RandomAccessibleInterval< T > extends RandomAccessible< T >, Interval
{
/*
* Get an instance of {@code T}.
* <p>
* It should not be assumed that the returned {@code T} instance is an
* independent copy. In particular, repeated calls to {@code getType()} may
* return the same instance.
* <p>
* The default implementation queries the value at the min coordinate of
* this interval. Derived classes may choose different implementations for
* improved performance.
*
* @return an instance of {@code T}
* NB: We cannot have a default implementation here because of
* https://bugs.openjdk.org/browse/JDK-7120669
*/
// @Override
// default T getType()
Expand Down
15 changes: 3 additions & 12 deletions src/main/java/net/imglib2/RealRandomAccessible.java
Original file line number Diff line number Diff line change
Expand Up @@ -120,18 +120,9 @@ default T getAt( final RealLocalizable position )
return realRandomAccess().setPositionAndGet( position );
}

/**
* Get an instance of {@code T}.
* <p>
* It should not be assumed that the returned {@code T} instance is an
* independent copy. In particular, repeated calls to {@code getType()} may
* return the same instance.
* <p>
* The default implementation queries the value at the default coordinate of
* {@link RealRandomAccessible#realRandomAccess()}. Derived classes
* may choose different implementations for improved performance.
*
* @return an instance of {@code T}
/*
* NB: We cannot have a default implementation here because of
* https://bugs.openjdk.org/browse/JDK-7120669
*/
// @Override
// default T getType()
Expand Down
15 changes: 3 additions & 12 deletions src/main/java/net/imglib2/RealRandomAccessibleRealInterval.java
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,9 @@
*/
public interface RealRandomAccessibleRealInterval< T > extends RealRandomAccessible< T >, RealInterval
{
/**
* Get an instance of {@code T}.
* <p>
* It should not be assumed that the returned {@code T} instance is an
* independent copy. In particular, repeated calls to {@code getType()} may
* return the same instance.
* <p>
* The default implementation queries the value at the min coordinate of
* this interval. Derived classes may choose different implementations for
* improved performance.
*
* @return an instance of {@code T}
/*
* NB: We cannot have a default implementation here because of
* https://bugs.openjdk.org/browse/JDK-7120669
*/
// @Override
// default T getType()
Expand Down

0 comments on commit 57160bc

Please sign in to comment.