Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
tpietzsch committed Apr 21, 2021
1 parent 1f0f576 commit 56969db
Showing 1 changed file with 16 additions and 35 deletions.
51 changes: 16 additions & 35 deletions src/main/java/net/imglib2/type/NativeType.java
Original file line number Diff line number Diff line change
Expand Up @@ -128,17 +128,16 @@ public interface NativeType< T extends NativeType< T > > extends Type< T >
*/
void updateContainer( Object c );

/**
* Get the (modifiable) index into the current data array. The returned
* instance will always be the same for the same Type.
*/
Index index();

/**
* Set the index into the current data array.
*
* <p>
* This is used by accessors (e.g., a {@link Cursor}) to position the
* {@link NativeType} in the container.
*
* @param i
* the new array index
* @deprecated Use {@code index().set(int)} instead. If possible, request the
* {@code index()} object only once and re-use it.
*/
@Deprecated
default void updateIndex( final int i )
Expand All @@ -148,12 +147,8 @@ default void updateIndex( final int i )

/**
* Get the current index into the current data array.
*
* <p>
* This is used by accessors (e.g., a {@link Cursor}) to position the
* {@link NativeType} in the container.
*
* @return the current index into the underlying data array
* @deprecated Use {@code index().get()} instead. If possible, request the
* {@code index()} object only once and re-use it.
*/
@Deprecated
default int getIndex()
Expand All @@ -163,10 +158,8 @@ default int getIndex()

/**
* Increment the index into the current data array.
*
* <p>
* This is used by accessors (e.g., a {@link Cursor}) to position the
* {@link NativeType} in the container.
* @deprecated Use {@code index().inc()} instead. If possible, request the
* {@code index()} object only once and re-use it.
*/
@Deprecated
default void incIndex()
Expand All @@ -177,13 +170,8 @@ default void incIndex()
/**
* Increases the index into the current data array by {@code increment}
* steps.
*
* <p>
* This is used by accessors (e.g., a {@link Cursor}) to position the
* {@link NativeType} in the container.
*
* @param increment
* how many steps
* @deprecated Use {@code index().inc(int)} instead. If possible, request the
* {@code index()} object only once and re-use it.
*/
@Deprecated
default void incIndex( final int increment )
Expand All @@ -193,10 +181,8 @@ default void incIndex( final int increment )

/**
* Decrement the index into the current data array.
*
* <p>
* This is used by accessors (e.g., a {@link Cursor}) to position the
* {@link NativeType} in the container.
* @deprecated Use {@code index().dec()} instead. If possible, request the
* {@code index()} object only once and re-use it.
*/
@Deprecated
default void decIndex()
Expand All @@ -207,13 +193,8 @@ default void decIndex()
/**
* Decrease the index into the current data array by {@code decrement}
* steps.
*
* <p>
* This is used by accessors (e.g., a {@link Cursor}) to position the
* {@link NativeType} in the container.
*
* @param decrement
* how many steps
* @deprecated Use {@code index().dec(int)} instead. If possible, request the
* {@code index()} object only once and re-use it.
*/
@Deprecated
default void decIndex( final int decrement )
Expand Down

0 comments on commit 56969db

Please sign in to comment.