moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Javadoc fixes - @see and @link can't be combined together, at least not in Java 6

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1748157 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2016-06-13 09:38:12 +00:00
parent 48eb5c521b
commit b8c13b6cc8
1 changed files with 37 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
src/java/org/apache/poi/ss/util/RegionUtil.java
View File

@ -25,12 +25,10 @@ import org.apache.poi.ss.usermodel.Workbook;
/** /**
* Various utility functions that make working with a region of cells easier. * Various utility functions that make working with a region of cells easier.
* *
* @see {@link BorderPropertyTemplate} to store border changes to a data structure * @see BorderPropertyTemplate <code>BorderPropertyTemplate</code>
* and apply the changes to multiple sheets. <code>BorderPropertyTemplate</code> * to store border changes to a data structure and apply the changes to
* multiple sheets. <code>BorderPropertyTemplate</code>
* also supports setting INTERNAL borders within a region. * also supports setting INTERNAL borders within a region.
*
* @author Eric Pugh epugh@upstate.com
* @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
*/ */
public final class RegionUtil { public final class RegionUtil {
@ -63,13 +61,14 @@ public final class RegionUtil {
* Sets the left border for a region of cells by manipulating the cell style of the individual * Sets the left border for a region of cells by manipulating the cell style of the individual
* cells on the left * cells on the left
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on. * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
* @deprecated 3.15 beta 2. Use {@link #setBorderLeft(int, CellRangeAddress, Sheet). * @deprecated 3.15 beta 2. Use {@link #setBorderLeft(int, CellRangeAddress, Sheet)}
*/ */
public static void setBorderLeft(int border, CellRangeAddress region, Sheet sheet, Workbook workbook) { public static void setBorderLeft(int border, CellRangeAddress region, Sheet sheet, Workbook workbook) {
setBorderLeft(border, region, sheet); setBorderLeft(border, region, sheet);
@ -78,11 +77,11 @@ public final class RegionUtil {
* Sets the left border for a region of cells by manipulating the cell style of the individual * Sets the left border for a region of cells by manipulating the cell style of the individual
* cells on the left * cells on the left
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setBorderLeft(int border, CellRangeAddress region, Sheet sheet) { public static void setBorderLeft(int border, CellRangeAddress region, Sheet sheet) {
@ -100,7 +99,8 @@ public final class RegionUtil {
* Sets the left border color for a region of cells by manipulating the cell style of the individual * Sets the left border color for a region of cells by manipulating the cell style of the individual
* cells on the left * cells on the left
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
@ -115,11 +115,11 @@ public final class RegionUtil {
* Sets the left border color for a region of cells by manipulating the cell style of the individual * Sets the left border color for a region of cells by manipulating the cell style of the individual
* cells on the left * cells on the left
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setLeftBorderColor(int color, CellRangeAddress region, Sheet sheet) { public static void setLeftBorderColor(int color, CellRangeAddress region, Sheet sheet) {
@ -137,7 +137,8 @@ public final class RegionUtil {
* Sets the right border for a region of cells by manipulating the cell style of the individual * Sets the right border for a region of cells by manipulating the cell style of the individual
* cells on the right * cells on the right
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
@ -152,11 +153,11 @@ public final class RegionUtil {
* Sets the right border for a region of cells by manipulating the cell style of the individual * Sets the right border for a region of cells by manipulating the cell style of the individual
* cells on the right * cells on the right
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setBorderRight(int border, CellRangeAddress region, Sheet sheet) { public static void setBorderRight(int border, CellRangeAddress region, Sheet sheet) {
@ -174,7 +175,8 @@ public final class RegionUtil {
* Sets the right border color for a region of cells by manipulating the cell style of the individual * Sets the right border color for a region of cells by manipulating the cell style of the individual
* cells on the right * cells on the right
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
@ -189,11 +191,11 @@ public final class RegionUtil {
* Sets the right border color for a region of cells by manipulating the cell style of the individual * Sets the right border color for a region of cells by manipulating the cell style of the individual
* cells on the right * cells on the right
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setRightBorderColor(int color, CellRangeAddress region, Sheet sheet) { public static void setRightBorderColor(int color, CellRangeAddress region, Sheet sheet) {
@ -211,13 +213,14 @@ public final class RegionUtil {
* Sets the bottom border for a region of cells by manipulating the cell style of the individual * Sets the bottom border for a region of cells by manipulating the cell style of the individual
* cells on the bottom * cells on the bottom
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on. * @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
* @deprecated 3.15 beta 2. Use {@link #setBorderBottom(int, CellRangeAddress, Sheet). * @deprecated 3.15 beta 2. Use {@link #setBorderBottom(int, CellRangeAddress, Sheet)}
*/ */
public static void setBorderBottom(int border, CellRangeAddress region, Sheet sheet, Workbook workbook) { public static void setBorderBottom(int border, CellRangeAddress region, Sheet sheet, Workbook workbook) {
setBorderBottom(border, region, sheet); setBorderBottom(border, region, sheet);
@ -226,11 +229,11 @@ public final class RegionUtil {
* Sets the bottom border for a region of cells by manipulating the cell style of the individual * Sets the bottom border for a region of cells by manipulating the cell style of the individual
* cells on the bottom * cells on the bottom
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setBorderBottom(int border, CellRangeAddress region, Sheet sheet) { public static void setBorderBottom(int border, CellRangeAddress region, Sheet sheet) {
@ -248,7 +251,8 @@ public final class RegionUtil {
* Sets the bottom border color for a region of cells by manipulating the cell style of the individual * Sets the bottom border color for a region of cells by manipulating the cell style of the individual
* cells on the bottom * cells on the bottom
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
@ -263,11 +267,11 @@ public final class RegionUtil {
* Sets the bottom border color for a region of cells by manipulating the cell style of the individual * Sets the bottom border color for a region of cells by manipulating the cell style of the individual
* cells on the bottom * cells on the bottom
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setBottomBorderColor(int color, CellRangeAddress region, Sheet sheet) { public static void setBottomBorderColor(int color, CellRangeAddress region, Sheet sheet) {
@ -285,7 +289,8 @@ public final class RegionUtil {
* Sets the top border for a region of cells by manipulating the cell style of the individual * Sets the top border for a region of cells by manipulating the cell style of the individual
* cells on the top * cells on the top
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
@ -300,11 +305,11 @@ public final class RegionUtil {
* Sets the top border for a region of cells by manipulating the cell style of the individual * Sets the top border for a region of cells by manipulating the cell style of the individual
* cells on the top * cells on the top
* *
* @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param border The new border * @param border The new border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setBorderTop(int border, CellRangeAddress region, Sheet sheet) { public static void setBorderTop(int border, CellRangeAddress region, Sheet sheet) {
@ -322,7 +327,8 @@ public final class RegionUtil {
* Sets the top border color for a region of cells by manipulating the cell style of the individual * Sets the top border color for a region of cells by manipulating the cell style of the individual
* cells on the top * cells on the top
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
@ -337,11 +343,11 @@ public final class RegionUtil {
* Sets the top border color for a region of cells by manipulating the cell style of the individual * Sets the top border color for a region of cells by manipulating the cell style of the individual
* cells on the top * cells on the top
* *
* @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality * @see BorderPropertyTemplate#drawBorders
* <code>BorderPropertyTemplate#drawBorders</code> for improved border functionality
* *
* @param color The color of the border * @param color The color of the border
* @param region The region that should have the border * @param region The region that should have the border
* @param workbook The workbook that the region is on.
* @param sheet The sheet that the region is on. * @param sheet The sheet that the region is on.
*/ */
public static void setTopBorderColor(int color, CellRangeAddress region, Sheet sheet) { public static void setTopBorderColor(int color, CellRangeAddress region, Sheet sheet) {