bug 59873: add @Internal and @Deprecated decorators to HyperlinkType enum

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1753062 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Javen O'Neal 2016-07-17 11:56:13 +00:00
parent 9133eaa147
commit bc91641444
2 changed files with 34 additions and 0 deletions

View File

@ -49,7 +49,23 @@ public enum HyperlinkType {
*/ */
FILE(4); FILE(4);
/** @deprecated POI 3.15 beta 3 */
@Internal(since="3.15 beta 3")
@Deprecated
private final int code; private final int code;
/**
* The codes don't have any real meaning.
* There bytes that are read in and written out from HSSF, HSLF, XSSF, and XSLF are different
* that the codes here.
* These codes only exist to assist in transitioning from using ints to enums.
*
* @param code
* @deprecated POI 3.15 beta 3
*/
@Internal(since="3.15 beta 3")
@Deprecated
private HyperlinkType(int code) { private HyperlinkType(int code) {
this.code = code; this.code = code;
} }
@ -61,10 +77,26 @@ public enum HyperlinkType {
} }
} }
/**
* @deprecated POI 3.15 beta 3
*
* @return the old integer code for a HyperlinkType enum
*/
@Internal(since="3.15 beta 3")
@Deprecated
public int getCode() { public int getCode() {
return code; return code;
} }
/**
* @deprecated POI 3.15 beta 3
*
* @param code the old integer code
* @return the corresponding HyperlinkEnum, if it exists
* @throws IllegalArgumentException if {@code code} is not a valid HyperlinkType.
*/
@Internal(since="3.15 beta 3")
@Deprecated
public static HyperlinkType forInt(int code) { public static HyperlinkType forInt(int code) {
HyperlinkType type = map.get(code); HyperlinkType type = map.get(code);
if (type == null) { if (type == null) {

View File

@ -213,7 +213,9 @@ public class BaseTestCellUtil {
* @deprecated by {@link #setAlignmentEnum()} * @deprecated by {@link #setAlignmentEnum()}
* *
* @throws IOException * @throws IOException
*
*/ */
@SuppressWarnings("deprecated")
@Test @Test
public void setAlignment() throws IOException { public void setAlignment() throws IOException {
Workbook wb = _testDataProvider.createWorkbook(); Workbook wb = _testDataProvider.createWorkbook();