https://github.com/chill-astro/openscan

OpenScan is an Open-Source Implementation of Scanner Class in Java but more Efficient.
https://github.com/chill-astro/openscan

console foss input java object object-oriented object-oriented-programming open-source scanner user-input utility

Last synced: 7 months ago
JSON representation

OpenScan is an Open-Source Implementation of Scanner Class in Java but more Efficient.

• Host: GitHub
• URL: https://github.com/chill-astro/openscan
• Owner: Chill-Astro
• License: gpl-3.0
• Created: 2025-04-18T17:06:37.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-05-21T16:41:52.000Z (8 months ago)
• Last Synced: 2025-06-04T18:54:25.350Z (7 months ago)
• Topics: console, foss, input, java, object, object-oriented, object-oriented-programming, open-source, scanner, user-input, utility
• Language: Java
• Homepage: https://github.com/Chill-Astro/OpenScan
• Size: 94.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  



 

OpenScan is a robust, efficient, and versatile Java library designed to replace the standard Scanner class for handling user input. It offers significant advantages in terms of performance, error handling, and flexibility, especially when dealing with large inputs or complex data formats.


---

## Getting Started :

1.  **Download:** Clone or download the `OpenScan.java` file from this repository.

2.  **Include:** Add the `OpenScan.java` file to your Java project.

3.  **Create Object:** Create an Object from this Code:

    ```java

    OpenScan  = new OpenScan();

    ```

---

## Usings :

 

Assuming that sc is your OpenScan object,

 - sc.next() reads the next token from the input.

 - sc.nextInt() reads the next token as an integer.

 - sc.nextDouble() reads the next token as a double.

 - sc.nextLine() reads the next line of text.

 - sc.nextChar() reads the first character of the next token.

 - sc.nextBoolean() reads the next token as a boolean.

 - sc.nextShort() reads the next token as a short.

 - sc.nextByte() reads the next token as a byte.

 - sc.nextLong() reads the next token as a long.

 - sc.nextFloat() reads the next token as a float.

 - sc.nextStringList() reads all remaining tokens from the current line as Strings.

 - sc.nextIntArray(int count) reads multiple integers from the current line.

 - sc.nextLongArray(int count) reads multiple longs from the current line.

 - sc.nextDoubleArray(int count) reads multiple doubles from the current line.

 - sc.readAllInts() reads all integers from the input until the end of input.

 - sc.readAllDoubles() reads all doubles from the input until the end of input.

 - sc.readAllLongs() reads all longs from the input until the end of input.

 - sc.readAllStrings() reads all strings from the input until the end of input.

 - sc.skipLines(int linesToSkip) skips a specified number of lines from the input.

 - sc.hasNext() checks if there is another token available.

 - sc.close() closes the underlying BufferedReader.

---

## Key Features and Advantages :

*   **Enhanced Performance:**

    *   Leverages `BufferedReader` for efficient line-by-line reading.

    *   Uses buffering to reduce the number of physical read operations, resulting in faster I/O.

*   **Line-Oriented Input:**

    *   `nextLine()` method efficiently reads entire lines, unlike `Scanner`'s token-based approach.

*   **Robust Error Handling:**

    *   Explicitly throws `NoSuchElementException` when input is exhausted.

    *   Throws `NumberFormatException` for invalid numeric input.

    *   Throws `RuntimeException` (wrapping `IOException`) for I/O errors.

    *   Handles empty tokens when `nextChar()` is called.

*   **Automatic Resource Management:**

    *   Implements `AutoCloseable`, allowing for use with try-with-resources, ensuring proper resource cleanup.

*   **Comprehensive Data Type Support:**

    *   Directly reads various data types: `int`, `long`, `double`, `float`, `boolean`, `char`, `short`, `byte`.

*   **Array and List Reading:**

    *   `nextIntArray()`, `nextLongArray()`, `nextDoubleArray()` read multiple values into arrays.

    *   `nextStringList()` reads all tokens on a line into a `List`.

* **Complete Data Loading:**

    * `readAllInts()`, `readAllDoubles()`, `readAllLongs()`, `readAllStrings()` reads all the available data from the input stream.

*   **Input Control:**

    *   `skipLines()` to efficiently skip over unwanted lines of input.

*   **Clear tokenizer**

    * `nextLine()` method clears the tokenizer by assigning null.

*   **Robust Checking**

    * `hasNext()` method checks properly if the new token is available.

* **Detailed Exception Handling:**

    * It handles all the exceptions clearly.

---

## Note from Developer :

Appreciate my effort? Why not leave a Star ⭐ ! Also if forked, please credit me for my effort and thanks if you do! :)

---