Index checker annotations for ResultSetMetaData.java

Author: PRITI1999

src/java.sql/share/classes/java/sql/ResultSetMetaData.java

@@ -25,6 +25,10 @@
 
 package java.sql;
 
+import org.checkerframework.common.value.qual.IntVal;
+import org.checkerframework.checker.index.qual.NonNegative;
+import org.checkerframework.checker.index.qual.Positive;
+
 /**
  * An object that can be used to get information about the types
  * and properties of the columns in a <code>ResultSet</code> object.
@@ -52,7 +56,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return the number of columns
      * @exception SQLException if a database access error occurs
      */
-    int getColumnCount() throws SQLException;
+    @NonNegative int getColumnCount() throws SQLException;
 
     /**
      * Indicates whether the designated column is automatically numbered.
@@ -61,7 +65,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isAutoIncrement(int column) throws SQLException;
+    boolean isAutoIncrement(@Positive int column) throws SQLException;
 
     /**
      * Indicates whether a column's case matters.
@@ -70,7 +74,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isCaseSensitive(int column) throws SQLException;
+    boolean isCaseSensitive(@Positive int column) throws SQLException;
 
     /**
      * Indicates whether the designated column can be used in a where clause.
@@ -79,7 +83,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isSearchable(int column) throws SQLException;
+    boolean isSearchable(@Positive int column) throws SQLException;
 
     /**
      * Indicates whether the designated column is a cash value.
@@ -88,7 +92,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isCurrency(int column) throws SQLException;
+    boolean isCurrency(@Positive int column) throws SQLException;
 
     /**
      * Indicates the nullability of values in the designated column.
@@ -98,25 +102,25 @@ public interface ResultSetMetaData extends Wrapper {
      *          <code>columnNullable</code> or <code>columnNullableUnknown</code>
      * @exception SQLException if a database access error occurs
      */
-    int isNullable(int column) throws SQLException;
+    @IntVal({0,1,2}) int isNullable(@Positive int column) throws SQLException;
 
     /**
      * The constant indicating that a
      * column does not allow <code>NULL</code> values.
      */
-    int columnNoNulls = 0;
+    @IntVal(0) int columnNoNulls = 0;
 
     /**
      * The constant indicating that a
      * column allows <code>NULL</code> values.
      */
-    int columnNullable = 1;
+    @IntVal(1) int columnNullable = 1;
 
     /**
      * The constant indicating that the
      * nullability of a column's values is unknown.
      */
-    int columnNullableUnknown = 2;
+    @IntVal(2) int columnNullableUnknown = 2;
 
     /**
      * Indicates whether values in the designated column are signed numbers.
@@ -125,7 +129,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isSigned(int column) throws SQLException;
+    boolean isSigned(@Positive int column) throws SQLException;
 
     /**
      * Indicates the designated column's normal maximum width in characters.
@@ -135,7 +139,7 @@ public interface ResultSetMetaData extends Wrapper {
      *          of the designated column
      * @exception SQLException if a database access error occurs
      */
-    int getColumnDisplaySize(int column) throws SQLException;
+    @NonNegative int getColumnDisplaySize(@Positive int column) throws SQLException;
 
     /**
      * Gets the designated column's suggested title for use in printouts and
@@ -148,7 +152,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return the suggested column title
      * @exception SQLException if a database access error occurs
      */
-    String getColumnLabel(int column) throws SQLException;
+    String getColumnLabel(@Positive int column) throws SQLException;
 
     /**
      * Get the designated column's name.
@@ -157,7 +161,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return column name
      * @exception SQLException if a database access error occurs
      */
-    String getColumnName(int column) throws SQLException;
+    String getColumnName(@Positive int column) throws SQLException;
 
     /**
      * Get the designated column's table's schema.
@@ -166,7 +170,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return schema name or "" if not applicable
      * @exception SQLException if a database access error occurs
      */
-    String getSchemaName(int column) throws SQLException;
+    String getSchemaName(@Positive int column) throws SQLException;
 
     /**
      * Get the designated column's specified column size.
@@ -180,7 +184,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return precision
      * @exception SQLException if a database access error occurs
      */
-    int getPrecision(int column) throws SQLException;
+    @NonNegative int getPrecision(@Positive int column) throws SQLException;
 
     /**
      * Gets the designated column's number of digits to right of the decimal point.
@@ -190,7 +194,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return scale
      * @exception SQLException if a database access error occurs
      */
-    int getScale(int column) throws SQLException;
+    @NonNegative int getScale(@Positive int column) throws SQLException;
 
     /**
      * Gets the designated column's table name.
@@ -199,7 +203,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return table name or "" if not applicable
      * @exception SQLException if a database access error occurs
      */
-    String getTableName(int column) throws SQLException;
+    String getTableName(@Positive int column) throws SQLException;
 
     /**
      * Gets the designated column's table's catalog name.
@@ -209,7 +213,7 @@ public interface ResultSetMetaData extends Wrapper {
      *          appears or "" if not applicable
      * @exception SQLException if a database access error occurs
      */
-    String getCatalogName(int column) throws SQLException;
+    String getCatalogName(@Positive int column) throws SQLException;
 
     /**
      * Retrieves the designated column's SQL type.
@@ -219,7 +223,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @exception SQLException if a database access error occurs
      * @see Types
      */
-    int getColumnType(int column) throws SQLException;
+    int getColumnType(@Positive int column) throws SQLException;
 
     /**
      * Retrieves the designated column's database-specific type name.
@@ -229,7 +233,7 @@ public interface ResultSetMetaData extends Wrapper {
      * a user-defined type, then a fully-qualified type name is returned.
      * @exception SQLException if a database access error occurs
      */
-    String getColumnTypeName(int column) throws SQLException;
+    String getColumnTypeName(@Positive int column) throws SQLException;
 
     /**
      * Indicates whether the designated column is definitely not writable.
@@ -238,7 +242,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isReadOnly(int column) throws SQLException;
+    boolean isReadOnly(@Positive int column) throws SQLException;
 
     /**
      * Indicates whether it is possible for a write on the designated column to succeed.
@@ -247,7 +251,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isWritable(int column) throws SQLException;
+    boolean isWritable(@Positive int column) throws SQLException;
 
     /**
      * Indicates whether a write on the designated column will definitely succeed.
@@ -256,7 +260,7 @@ public interface ResultSetMetaData extends Wrapper {
      * @return <code>true</code> if so; <code>false</code> otherwise
      * @exception SQLException if a database access error occurs
      */
-    boolean isDefinitelyWritable(int column) throws SQLException;
+    boolean isDefinitelyWritable(@Positive int column) throws SQLException;
 
     //--------------------------JDBC 2.0-----------------------------------
 
@@ -275,5 +279,5 @@ public interface ResultSetMetaData extends Wrapper {
      * @exception SQLException if a database access error occurs
      * @since 1.2
      */
-    String getColumnClassName(int column) throws SQLException;
+    String getColumnClassName(@Positive int column) throws SQLException;
 }