Annotation Type GTENegativeOne


  • @Documented
    @Retention(RUNTIME)
    @Target({TYPE_USE,TYPE_PARAMETER})
    @SubtypeOf(LowerBoundUnknown.class)
    public @interface GTENegativeOne
    The annotated expression evaluates to an integer greater than or equal to -1. ("GTE" stands for ``Greater Than or Equal to''.)

    As an example use case, consider the definition of the read() method in java.io.InputStream:

    
          Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255.
          If no byte is available because the end of the stream has been reached, the value -1 is returned.
          This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.
          A subclass must provide an implementation of this method.
    
          Returns: the next byte of data, or -1 if the end of the stream is reached.
          Throws: IOException - if an I/O error occurs.
    
         public abstract @GTENegativeOne int read() throws IOException;
     
    See the Checker Framework Manual:
    Index Checker