Skip to content

docs: fill in missing replacement guidance for deprecated APIs #1261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GOODBOY008 wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −4
Open

docs: fill in missing replacement guidance for deprecated APIs #1261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions fesod-sheet/src/main/java/org/apache/fesod/sheet/cache/Ehcache.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ public class Ehcache implements ReadCache {
*/
private int cacheMiss = 0;

/**
* @param maxCacheActivateSize
* maximum size of the activated cache
* @deprecated use {@link #Ehcache(Integer, Integer)} instead, which also accepts a batch count
*/
@Deprecated
public Ehcache(Integer maxCacheActivateSize) {
this(maxCacheActivateSize, null);
Expand Down
4 changes: 3 additions & 1 deletion fesod-sheet/src/main/java/org/apache/fesod/sheet/cache/selector/SimpleReadCacheSelector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public class SimpleReadCacheSelector implements ReadCacheSelector {
/**
* Maximum size of cache activation.unit MB.
*
* @deprecated Please use maxCacheActivateBatchCount to control the size of the occupied memory
* @deprecated use {@link #maxCacheActivateBatchCount} instead to control the occupied memory
*/
@Deprecated
private Integer maxCacheActivateSize;
Expand All @@ -87,6 +87,8 @@ public SimpleReadCacheSelector() {}
*
* @param maxUseMapCacheSize
* @param maxCacheActivateSize
* @deprecated use {@link #SimpleReadCacheSelector()} plus {@link #setMaxCacheActivateBatchCount(Integer)}
* instead; {@code maxCacheActivateSize} is no longer honored
*/
@Deprecated
public SimpleReadCacheSelector(Long maxUseMapCacheSize, Integer maxCacheActivateSize) {
Expand Down
4 changes: 2 additions & 2 deletions fesod-sheet/src/main/java/org/apache/fesod/sheet/context/WriteContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public interface WriteContext {
* Current sheet
*
* @return
* @deprecated please us e{@link #writeSheetHolder()}
* @deprecated please use {@link #writeSheetHolder()}
*/
@Deprecated
Sheet getCurrentSheet();
Expand All @@ -106,7 +106,7 @@ public interface WriteContext {
* Need head
*
* @return
* @deprecated please us e{@link #writeSheetHolder()}
* @deprecated please use {@link #writeSheetHolder()}
*/
@Deprecated
boolean needHead();
Expand Down
2 changes: 2 additions & 0 deletions fesod-sheet/src/main/java/org/apache/fesod/sheet/converters/string/StringImageConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
* String and image converter
*
* @see StringPathnameImageConverter
* @deprecated use {@link StringPathnameImageConverter} instead, which has the same behaviour under a
* name that reflects it
*/
@Deprecated
public class StringImageConverter implements Converter<String> {
Expand Down
2 changes: 1 addition & 1 deletion fesod-sheet/src/main/java/org/apache/fesod/sheet/read/metadata/holder/ReadSheetHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ public ReadSheetHolder(ReadSheet readSheet, ReadWorkbookHolder readWorkbookHolde

/**
* Approximate total number of rows.
* use: getApproximateTotalRowNumber()
*
* @return
* @deprecated use {@link #getApproximateTotalRowNumber()} instead
*/
@Deprecated
public Integer getTotal() {
Expand Down
Loading